metadata

package

v0.0.0-...-d2fa2ec Latest Latest Go to latest Published: Mar 8, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/discentem/cavorite

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func HashFromCfileMatches(fsys afero.Fs, cfile string, expected string) (bool, error)
func SHA256FromReader(r io.Reader) (string, error)
func WriteToFsys(req FsysWriteRequest) (err error)
type CfileMetadataMap
type FsysWriteRequest
type ObjectMetaData

Constants ¶

View Source

const MetadataFileExtension string = "cfile"

Variables ¶

View Source

var (
	ErrFileExtensionEmpty          = fmt.Errorf("options.MetadatafileExtension cannot be %q", "")
	ErrRetrieveFailureHashMismatch = errors.New("hashes don't match, Retrieve aborted")
)

Functions ¶

func HashFromCfileMatches ¶

func HashFromCfileMatches(fsys afero.Fs, cfile string, expected string) (bool, error)

func SHA256FromReader ¶

func SHA256FromReader(r io.Reader) (string, error)

func WriteToFsys ¶

func WriteToFsys(req FsysWriteRequest) (err error)

WriteToFsys generates Cavorite metadata for req.Object and writes it to req.Fsys

Types ¶

type CfileMetadataMap ¶

type CfileMetadataMap map[string]ObjectMetaData

type FsysWriteRequest ¶

type FsysWriteRequest struct {
	Object       string
	Fsys         afero.Fs
	Fi           afero.File
	MetadataPath string
	Extension    string
}

type ObjectMetaData ¶

type ObjectMetaData struct {
	Name         string    `json:"name"`
	Checksum     string    `json:"checksum"`
	DateModified time.Time `json:"date_modified"`
}

func GenerateFromFile ¶

func GenerateFromFile(f afero.File, key string) (*ObjectMetaData, error)

func GenerateFromReader ¶

func GenerateFromReader(name string, modTime time.Time, r io.Reader) (*ObjectMetaData, error)

func ParseCfile ¶

func ParseCfile(fsys afero.Fs, obj string) (*ObjectMetaData, error)

func ParseCfileWithExtension ¶

func ParseCfileWithExtension(fsys afero.Fs, obj, ext string) (*ObjectMetaData, error)

Source Files ¶

View all Source files

metadata.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL