github.com/bhojpur/cache@v0.0.4/pkg/file/types/databaseheader.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  	"encoding/json"
    25  	"time"
    26  
    27  	"github.com/bhojpur/cache/pkg/file/crypto"
    28  )
    29  
    30  // DatabaseHeader is the identifier for a database.
    31  type DatabaseHeader struct {
    32  	Label   string      `json:"label"`   // A database label
    33  	Created string      `json:"created"` // The time that the database was created
    34  	Hash    crypto.Hash `json:"hash"`    // The hash of the database header
    35  }
    36  
    37  // NewDatabaseHeader creates a new database header.
    38  func NewDatabaseHeader(label string) DatabaseHeader {
    39  	// Create the header
    40  	newDatabaseHeader := DatabaseHeader{
    41  		Label:   label,
    42  		Created: time.Now().String(), // The timestamp
    43  	}
    44  
    45  	// Compute the header hash and return
    46  	newDatabaseHeader.Hash = crypto.Sha3(newDatabaseHeader.Bytes())
    47  	return newDatabaseHeader
    48  }
    49  
    50  /* ----- BEGIN HELPER FUNCTIONS ----- */
    51  
    52  // Bytes converts the database header to bytes.
    53  func (databaseHeader DatabaseHeader) Bytes() []byte {
    54  	json, _ := json.MarshalIndent(databaseHeader, "", "  ")
    55  	return json
    56  }
    57  
    58  // String converts the database to a string.
    59  func (databaseHeader DatabaseHeader) String() string {
    60  	json, _ := json.MarshalIndent(databaseHeader, "", "  ")
    61  	return string(json)
    62  }
    63  
    64  /* ----- END HELPER FUNCTIONS ----- */