github.com/m3db/m3@v1.5.0/src/m3em/build/types.go (about)

     1  // Copyright (c) 2017 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 build
    22  
    23  import (
    24  	"github.com/m3db/m3/src/m3em/os/fs"
    25  )
    26  
    27  // IterableBytesWithID represents the an iterable byte stream associated
    28  // with an identifier
    29  type IterableBytesWithID interface {
    30  	// ID returns a string identifier for the build
    31  	ID() string
    32  
    33  	// Iter returns an iterator to loop over the contents of the build
    34  	Iter(bufferSize int) (fs.FileReaderIter, error)
    35  }
    36  
    37  // ServiceBuild represents a single build of a service, available locally.
    38  type ServiceBuild interface {
    39  	IterableBytesWithID
    40  
    41  	// SourcePath returns a local path where the service build is available
    42  	SourcePath() string
    43  }
    44  
    45  // ServiceConfiguration represents the configuration required to operate a service
    46  type ServiceConfiguration interface {
    47  	IterableBytesWithID
    48  
    49  	// Bytes returns a UTF-8 serialized representation of the service configuration
    50  	Bytes() ([]byte, error)
    51  }