github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/resource/close.go (about)

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package resource
    22  
    23  import (
    24  	"errors"
    25  
    26  	xerrors "github.com/m3db/m3/src/x/errors"
    27  )
    28  
    29  var (
    30  	// ErrNotCloseable is returned when trying to close a resource
    31  	// that does not conform to a closeable interface.
    32  	ErrNotCloseable = errors.New("not a closeable resource")
    33  )
    34  
    35  // TryClose attempts to close a resource, the resource is expected to
    36  // implement either Closeable or CloseableResult.
    37  func TryClose(r interface{}) error {
    38  	if r, ok := r.(Closer); ok {
    39  		return r.Close()
    40  	}
    41  	if r, ok := r.(SimpleCloser); ok {
    42  		r.Close()
    43  		return nil
    44  	}
    45  	return ErrNotCloseable
    46  }
    47  
    48  // CloseAll closes all closers and combines any errors.
    49  func CloseAll(closers ...Closer) error {
    50  	multiErr := xerrors.NewMultiError()
    51  	for _, closer := range closers {
    52  		if err := closer.Close(); err != nil {
    53  			multiErr = multiErr.Add(err)
    54  		}
    55  	}
    56  
    57  	return multiErr.FinalError()
    58  }