filemeta

README

filemeta

Extraction of file metadata, including the hash, stored to extended attributes

Documentation

Index

• Constants
• Variables
• func ReadCustom(fileName string, attrName string, data proto.Message) error
• func SyncOperations(op Op) (func(string) Data, func())
• func WriteCustom(fileName string, attrName string, data proto.Message) error
• type Async
  • func AsyncMono(op Op) Async
  • func AsyncOperations(op Op, probeThreads int, hashThreads int) Async
• type Attr
• type Attributes
  • func (*Attributes) Descriptor() ([]byte, []int)
  • func (x *Attributes) GetHash() []byte
  • func (x *Attributes) GetSize() int64
  • func (x *Attributes) GetTimeNs() int64
  • func (*Attributes) ProtoMessage()
  • func (x *Attributes) ProtoReflect() protoreflect.Message
  • func (x *Attributes) Reset()
  • func (x *Attributes) String() string
  • func (attr *Attributes) Time() time.Time
• type Data
  • func Get(fileName string) Data
  • func Inspect(fileName string) Data
  • func Operation(op Op, fileName string) (data Data)
  • func Refresh(fileName string) Data
  • func Verify(fileName string) Data
  • func (d *Data) GetAttr() Attr
  • func (d *Data) GetModTime() time.Time
  • func (d *Data) Rename(newPath string) (err error)
  • func (d *Data) SetModTime(tim time.Time) (err error)
• type FetchFunc
• type FileWriter
  • func NewFileWriter() FileWriter
• type HashKey
  • func ToHashKey(x []byte) (k HashKey)
• type Op
  • func (op Op) String() string

Constants

const HashSize = blake2b.Size256

Variables

var File_filemeta_proto protoreflect.FileDescriptor

Functions

func ReadCustom

func ReadCustom(fileName string, attrName string, data proto.Message) error

func SyncOperations

func SyncOperations(op Op) (func(string) Data, func())

func WriteCustom

func WriteCustom(fileName string, attrName string, data proto.Message) error

Types

type Async

type Async struct {
	FileIn  chan string
	DataOut chan Data
}

func AsyncMono

func AsyncMono(op Op) Async

func AsyncOperations

func AsyncOperations(op Op, probeThreads int, hashThreads int) Async

type Attr

type Attr struct {
	Size   int64
	TimeNs int64
	Hash   []byte
}

type Attributes

type Attributes struct {
	Hash   []byte `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	TimeNs int64  `protobuf:"fixed64,2,opt,name=timeNs,proto3" json:"timeNs,omitempty"`
	Size   int64  `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

func (*Attributes) Descriptor

func (*Attributes) Descriptor() ([]byte, []int)

Deprecated: Use Attributes.ProtoReflect.Descriptor instead.

func (*Attributes) GetHash

func (x *Attributes) GetHash() []byte

func (*Attributes) GetSize

func (x *Attributes) GetSize() int64

func (*Attributes) GetTimeNs

func (x *Attributes) GetTimeNs() int64

func (*Attributes) ProtoMessage

func (*Attributes) ProtoMessage()

func (*Attributes) ProtoReflect

func (x *Attributes) ProtoReflect() protoreflect.Message

func (*Attributes) Reset

func (x *Attributes) Reset()

func (*Attributes) String

func (x *Attributes) String() string

func (*Attributes) Time

func (attr *Attributes) Time() time.Time

type Data

type Data struct {
	sys.FileInfo
	Hash         []byte
	Error        error
	Operation    Op
	Hashed       bool // the file has just been hashed
	Changed      bool // the file had attributes, but they are no longer valid
	VerifyFailed bool
	// contains filtered or unexported fields
}

func Get

func Get(fileName string) Data

Gets the metadata if available; if not available data.Attr is nil

func Inspect

func Inspect(fileName string) Data

Gets the metadata if available; returns an error if not

func Operation

func Operation(op Op, fileName string) (data Data)

func Refresh

func Refresh(fileName string) Data

Gets the metadata, refreshing it if necessary

func Verify

func Verify(fileName string) Data

Like get, but additional it verifies the hash (scrub)

func (*Data) GetAttr

func (d *Data) GetAttr() Attr

func (*Data) GetModTime

func (d *Data) GetModTime() time.Time

func (*Data) Rename

func (d *Data) Rename(newPath string) (err error)

func (*Data) SetModTime

func (d *Data) SetModTime(tim time.Time) (err error)

type FetchFunc

type FetchFunc func(fileName string) Data

type FileWriter

type FileWriter struct {
	Open  func(fileName string, fileFlags int, filePerm os.FileMode) error
	Write func([]byte) error
	Close func(fileTimeNs int64) (Attr, error)
}

func NewFileWriter

func NewFileWriter() FileWriter

type HashKey

type HashKey [HashSize]byte

func ToHashKey

func ToHashKey(x []byte) (k HashKey)

type Op

type Op int8

const (
	OpGet Op = iota
	OpVerify
	OpRefresh
	OpInspect
)

func (Op) String

func (op Op) String() string