README
¶
Local gitfs fork
This directory is a local fork of
rsc.io/gitfs v1.0.0, whose
upstream revision is
284116d826c0bc751ebac57c87fd01eb2ea95240.
It presents a file tree downloaded from a remote Git repository as an in-memory
fs.FS.
Within this repository it is part of the root module and is imported as
blake.io/git-lfs/gitfs.
This is not a release of upstream rsc.io/gitfs. Its API differs from
upstream, including the changed Clone and CloneHash signatures. Consumers
outside this repository should import blake.io/git-lfs/gitfs only when they
intentionally depend on this fork.
Local extensions
NewRepoWithClientaccepts a caller-provided HTTP client.Clone,CloneHash, and the newCloneTreeacceptCloneParams, which can send Git object-filter specifications and require server support for them.CloneParams.MaxPackSizeis required and positive; it limits received pack bytes and decoded object data. They return*Tree, a concretefs.FS.Tree.WritePackandTree.PackIDexpose the fetched pack, andTree.ReadEntryexposes a tree entry's Git mode and object hash.- Parsed tree entries are memoized for later lookups and directory reads.
- Malformed fetch sidebands return errors; server-progress sidebands are not written to standard output.
See NOTICE for provenance and LICENSE for the license that applies to this directory. The upstream API reference is available at pkg.go.dev/rsc.io/gitfs.
Documentation
¶
Overview ¶
Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CloneParams ¶
type CloneParams struct {
// MaxPackSize is the positive maximum size of the received pack. It also
// bounds the decoded objects and deltas retained while unpacking. It has no
// default.
MaxPackSize int64
Filters []string // Git object filter specifications.
}
CloneParams controls a clone. MaxPackSize must be positive.
type Repo ¶
type Repo struct {
// contains filtered or unexported fields
}
A Repo is a connection to a remote repository served over HTTP or HTTPS.
func NewRepoWithClient ¶
NewRepoWithClient connects to a Git repository using client. A nil client uses http.DefaultClient.
func (*Repo) CloneHash ¶
func (r *Repo) CloneHash(h Hash, params *CloneParams) (*Tree, error)
CloneHash returns the Tree for the given hash.
type Tree ¶
type Tree struct {
// contains filtered or unexported fields
}
A Tree is an fs.FS serving a Git file system tree rooted at a given tree object hash.
Source Files