github.com/bhojpur/cache@v0.0.4/pkg/file/types/sharddbmodel.go (about)

     1  package types
     2  
     3  // Copyright (c) 2018 Bhojpur Consulting Private Limited, India. All rights reserved.
     4  
     5  // Permission is hereby granted, free of charge, to any person obtaining a copy
     6  // of this software and associated documentation files (the "Software"), to deal
     7  // in the Software without restriction, including without limitation the rights
     8  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     9  // copies of the Software, and to permit persons to whom the Software is
    10  // furnished to do so, subject to the following conditions:
    11  
    12  // The above copyright notice and this permission notice shall be included in
    13  // all copies or substantial portions of the Software.
    14  
    15  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    16  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    17  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    18  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    19  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    20  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    21  // THE SOFTWARE.
    22  
    23  import (
    24  	"github.com/bhojpur/cache/pkg/file/crypto"
    25  )
    26  
    27  // shardID is the key model in the shard map (shard db).
    28  type shardID crypto.Hash
    29  
    30  // shardData is the value model in the shard map (shard db).
    31  type shardData struct {
    32  	Index  int    `json:"index"`   // The position of the shard out of all the shards for this file
    33  	NodeID NodeID `json:"node_id"` // The ID of the node holding the shard
    34  	Size   uint32 `json:"size"`    // The size in bytes of the shard
    35  }
    36  
    37  // generateShardEntry generates a shardID-shardData pair.
    38  func generateShardEntry(shard Shard, index int, nodeID NodeID) (shardID, shardData) {
    39  	shardData := shardData{
    40  		Index:  index,      // Set the index
    41  		NodeID: nodeID,     // Set the NodeID
    42  		Size:   shard.Size, // Get and set the size
    43  	}
    44  
    45  	return shardID(shard.Hash), shardData // Return the pair
    46  }