fileref

Documentation

Index

• Constants
• func GetReferenceLookup(allocationID string, path string) string
• type Attributes
  • func (a *Attributes) IsZero() bool
  • func (a *Attributes) Validate() (err error)
• type Collaborator
• type CommitMetaTxn
• type FileRef
  • func (fr *FileRef) CalculateHash() string
  • func (fr *FileRef) GetAttributes() Attributes
  • func (fr *FileRef) GetCreatedAt() string
  • func (fr *FileRef) GetHash() string
  • func (fr *FileRef) GetHashData() string
  • func (fr *FileRef) GetLookupHash() string
  • func (fr *FileRef) GetName() string
  • func (fr *FileRef) GetNumBlocks() int64
  • func (fr *FileRef) GetPath() string
  • func (fr *FileRef) GetPathHash() string
  • func (fr *FileRef) GetSize() int64
  • func (fr *FileRef) GetType() string
  • func (fr *FileRef) GetUpdatedAt() string
• type ListResult
  • func (lr *ListResult) GetDirTree(allocationID string) (*Ref, error)
• type Ref
  • func (r *Ref) AddChild(child RefEntity)
  • func (r *Ref) CalculateHash() string
  • func (r *Ref) GetAttributes() Attributes
  • func (r *Ref) GetCreatedAt() string
  • func (r *Ref) GetHash() string
  • func (r *Ref) GetLookupHash() string
  • func (r *Ref) GetName() string
  • func (r *Ref) GetNumBlocks() int64
  • func (r *Ref) GetPath() string
  • func (r *Ref) GetPathHash() string
  • func (r *Ref) GetSize() int64
  • func (r *Ref) GetType() string
  • func (r *Ref) GetUpdatedAt() string
  • func (r *Ref) RemoveChild(idx int)
• type RefEntity
• type ReferencePath
  • func (rp *ReferencePath) GetDirTree(allocationID string) (*Ref, error)
  • func (rp *ReferencePath) GetRefFromObjectTree(allocationID string) (RefEntity, error)

Constants

const (
	FILE      = "f"
	DIRECTORY = "d"
)

const CHUNK_SIZE = 64 * 1024

Functions

func GetReferenceLookup

func GetReferenceLookup(allocationID string, path string) string

Types

type Attributes

type Attributes struct {
	// The WhoPaysForReads represents reading payer. It can be allocation owner
	// or a 3rd party user. It affects read operations only. It requires
	// blobbers to be trusted.
	WhoPaysForReads common.WhoPays `json:"who_pays_for_reads,omitempty"`
}

The Attributes represents file attributes.

func (*Attributes) IsZero

func (a *Attributes) IsZero() bool

IsZero returns true, if the Attributes is zero.

func (*Attributes) Validate

func (a *Attributes) Validate() (err error)

Validate the Attributes.

type Collaborator

type Collaborator struct {
	RefID     int64  `json:"ref_id"`
	ClientID  string `json:"client_id"`
	CreatedAt string `json:"created_at"`
}

type CommitMetaTxn

type CommitMetaTxn struct {
	RefID     int64  `json:"ref_id"`
	TxnID     string `json:"txn_id"`
	CreatedAt string `json:"created_at"`
}

type FileRef

type FileRef struct {
	Ref                 `json:",squash"`
	CustomMeta          string          `json:"custom_meta"`
	ContentHash         string          `json:"content_hash"`
	MerkleRoot          string          `json:"merkle_root"`
	ThumbnailSize       int64           `json:"thumbnail_size"`
	ThumbnailHash       string          `json:"thumbnail_hash"`
	ActualFileSize      int64           `json:"actual_file_size"`
	ActualFileHash      string          `json:"actual_file_hash"`
	ActualThumbnailSize int64           `json:"actual_thumbnail_size"`
	ActualThumbnailHash string          `json:"actual_thumbnail_hash"`
	MimeType            string          `json:"mimetype"`
	EncryptedKey        string          `json:"encrypted_key"`
	CommitMetaTxns      []CommitMetaTxn `json:"commit_meta_txns"`
	Collaborators       []Collaborator  `json:"collaborators"`
	Attributes          Attributes      `json:"attributes"`
}

func (*FileRef) CalculateHash

func (fr *FileRef) CalculateHash() string

func (*FileRef) GetAttributes

func (fr *FileRef) GetAttributes() Attributes

func (*FileRef) GetCreatedAt

func (fr *FileRef) GetCreatedAt() string

func (*FileRef) GetHash

func (fr *FileRef) GetHash() string

func (*FileRef) GetHashData

func (fr *FileRef) GetHashData() string

func (*FileRef) GetLookupHash

func (fr *FileRef) GetLookupHash() string

func (*FileRef) GetName

func (fr *FileRef) GetName() string

func (*FileRef) GetNumBlocks

func (fr *FileRef) GetNumBlocks() int64

func (*FileRef) GetPath

func (fr *FileRef) GetPath() string

func (*FileRef) GetPathHash

func (fr *FileRef) GetPathHash() string

func (*FileRef) GetSize

func (fr *FileRef) GetSize() int64

func (*FileRef) GetType

func (fr *FileRef) GetType() string

func (*FileRef) GetUpdatedAt

func (fr *FileRef) GetUpdatedAt() string

type ListResult

type ListResult struct {
	AllocationRoot string                   `json:"allocation_root"`
	Meta           map[string]interface{}   `json:"meta_data"`
	Entities       []map[string]interface{} `json:"list"`
}

func (*ListResult) GetDirTree

func (lr *ListResult) GetDirTree(allocationID string) (*Ref, error)

type Ref

type Ref struct {
	Type         string     `json:"type"`
	AllocationID string     `json:"allocation_id"`
	Name         string     `json:"name"`
	Path         string     `json:"path"`
	Size         int64      `json:"size"`
	ActualSize   int64      `json:"actual_file_size"`
	Hash         string     `json:"hash"`
	ChunkSize    int64      `json:"chunk_size"`
	NumBlocks    int64      `json:"num_of_blocks"`
	PathHash     string     `json:"path_hash"`
	LookupHash   string     `json:"lookup_hash"`
	Attributes   Attributes `json:"attributes"`

	Children  []RefEntity `json:"-"`
	CreatedAt string      `json:"created_at"`
	UpdatedAt string      `json:"updated_at"`
	// contains filtered or unexported fields
}

func (*Ref) AddChild

func (r *Ref) AddChild(child RefEntity)

func (*Ref) CalculateHash

func (r *Ref) CalculateHash() string

func (*Ref) GetAttributes

func (r *Ref) GetAttributes() Attributes

func (*Ref) GetCreatedAt

func (r *Ref) GetCreatedAt() string

func (*Ref) GetHash

func (r *Ref) GetHash() string

func (*Ref) GetLookupHash

func (r *Ref) GetLookupHash() string

func (*Ref) GetName

func (r *Ref) GetName() string

func (*Ref) GetNumBlocks

func (r *Ref) GetNumBlocks() int64

func (*Ref) GetPath

func (r *Ref) GetPath() string

func (*Ref) GetPathHash

func (r *Ref) GetPathHash() string

func (*Ref) GetSize

func (r *Ref) GetSize() int64

func (*Ref) GetType

func (r *Ref) GetType() string

func (*Ref) GetUpdatedAt

func (r *Ref) GetUpdatedAt() string

func (*Ref) RemoveChild

func (r *Ref) RemoveChild(idx int)

type RefEntity

type RefEntity interface {
	GetNumBlocks() int64
	GetSize() int64
	GetHash() string
	CalculateHash() string
	GetType() string
	GetPathHash() string
	GetLookupHash() string
	GetPath() string
	GetName() string
	GetAttributes() Attributes
	GetCreatedAt() string
	GetUpdatedAt() string
}

type ReferencePath

type ReferencePath struct {
	Meta map[string]interface{} `json:"meta_data"`
	List []*ReferencePath       `json:"list,omitempty"`
}

func (*ReferencePath) GetDirTree

func (rp *ReferencePath) GetDirTree(allocationID string) (*Ref, error)

GetDirTree covert and build root Ref with children

func (*ReferencePath) GetRefFromObjectTree

func (rp *ReferencePath) GetRefFromObjectTree(allocationID string) (RefEntity, error)