Categorygithub.com/blobcache/glfs

modulepackage

0.0.0-20231022180745-6e0c3d89e0db

Repository: https://github.com/blobcache/glfs.git

Documentation: pkg.go.dev

# README

GLFS

GLFS is a Git-Like FileSystem.

If you are looking for a simple way to store objects larger than a single blob in blobcache, you have come to the right place.

Take a look at ARCHITECTURE.md to learn more about the design. If you have a good understanding of how Git works, that's about 9/10 of it. There are a few tricks not in Git.

Examples live in the examples/ directory.

# Packages

bigblob

No description provided by the author

examples

No description provided by the author

glfsposix

No description provided by the author

glfstar

package glfstar converts GLFS to/from TAR.

glfszip

No description provided by the author

# Functions

CleanPath

No description provided by the author

FilterPaths

FilterPaths returns a version of root with paths filtered using f as a predicate.

GC will remove objects from store which are not referenced by any of the refs in keep.

GetAtPath

GetAtPath returns a ref to the object under ref at subpath.

GetBlob

GetBlob returns an io.ReadSeeker for accessing data from the blob at x.

GetBlobBytes

GetBlobBytes reads the entire contents of the blob at x into memory and returns the slice of bytes.

GetTree

GetTree retreives the tree in store at Ref if it exists.

IsErrNoEnt

No description provided by the author

IsValidName

No description provided by the author

MapBlobs

MapBlobs calls MapBlobs on the default Agent.

MapEntryAt

MapEntryAt calls MapEntryAt on the default Agent.

MapLeaves

MapLeaves calls MapLeaves on the default Agent.

Merge

Merge calls Merge on the default Agent.

NewAgent

No description provided by the author

ParseType

No description provided by the author

PostBlob

PostBlob creates a new blob with data from r, and returns a Ref to it.

PostTree

PostTree writes a tree to CA storage and returns a Ref pointing to it.

PostTreeEntries

No description provided by the author

PostTreeMap

No description provided by the author

PostTyped

PostRaw calls PostRaw on the default Agent.

ShardLeaves

ShardLeaves calls ShardLeaves on the default Agent.

SizeOf

SizeOf returns the size of the data at x.

Sync

Sync ensures that all data referenced by x exists in dst, copying from src if necessary.

WalkRefs

WalkRefs calls fn with every Ref reacheable from ref, including Ref.

WalkTree

WalkTree walks the tree and calls f with tree entries in lexigraphical order file1.txt comes before file2.txt dir1/ comes before dir1/file1.txt.

WithSalt

WithSalt sets the salt used for deriving encryption keys.

# Constants

DefaultBlockSize

No description provided by the author

TypeBlob

No description provided by the author

TypeTree

No description provided by the author

# Structs

Agent

No description provided by the author

Diff

Diff contains the result of a Compare Left contains only elements in left Right contains only elements in right Both contains elements common to left and right.

ErrNoEnt

No description provided by the author

ErrRefType

No description provided by the author

GCResult

No description provided by the author

Ref

Ref is a reference to a glfs Object, which could be: - Tree - Blob.

Traverser

No description provided by the author

Tree

Tree is a directory of entries to other trees or blobs Each entry in a tree has a unique name.