github.com/m3db/m3@v1.5.0/src/dbnode/storage/block/metadata.go (about)

     1  // Copyright (c) 2016 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 block
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/ident"
    25  	xtime "github.com/m3db/m3/src/x/time"
    26  )
    27  
    28  // NewMetadata creates a new block metadata
    29  func NewMetadata(
    30  	id ident.ID,
    31  	tags ident.Tags,
    32  	start xtime.UnixNano,
    33  	size int64,
    34  	checksum *uint32,
    35  	lastRead xtime.UnixNano,
    36  ) Metadata {
    37  	return Metadata{
    38  		ID:       id,
    39  		Tags:     tags,
    40  		Start:    start,
    41  		Size:     size,
    42  		Checksum: checksum,
    43  		LastRead: lastRead,
    44  	}
    45  }
    46  
    47  // Finalize will finalize the ID and Tags on the metadata.
    48  func (m *Metadata) Finalize() {
    49  	if m.ID != nil {
    50  		m.ID.Finalize()
    51  		m.ID = nil
    52  	}
    53  	if m.Tags.Values() != nil {
    54  		m.Tags.Finalize()
    55  		m.Tags = ident.Tags{}
    56  	}
    57  }