gitfs

README

Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS. See the API reference.

Modifications from original version by Russ Cox:

• do not print to STDOUT
• context support

Documentation

Overview

Package gitfs presents a file tree downloaded from a remote Git repo as an in-memory fs.FS.

Index

• type Hash
  • func (h Hash) String() string
• type Repo
  • func NewRepo(ctx context.Context, url string) (*Repo, error)
  • func (r *Repo) Clone(ctx context.Context, ref string) (Hash, fs.FS, error)
  • func (r *Repo) CloneHash(ctx context.Context, h Hash) (fs.FS, error)
  • func (r *Repo) Refs(ctx context.Context, prefixes ...string) ([]ref, error)
  • func (r *Repo) Resolve(ctx context.Context, ref string) (Hash, error)

Types

type Hash

type Hash [20]byte

A Hash is a SHA-1 Hash identifying a particular Git object.

func (Hash) String

func (h Hash) String() string

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 NewRepo

func NewRepo(ctx context.Context, url string) (*Repo, error)

NewRepo connects to a Git repository at the given http:// or https:// URL.

func (*Repo) Clone

func (r *Repo) Clone(ctx context.Context, ref string) (Hash, fs.FS, error)

Clone resolves the given ref to a hash and returns the corresponding fs.FS.

func (*Repo) CloneHash

func (r *Repo) CloneHash(ctx context.Context, h Hash) (fs.FS, error)

CloneHash returns the fs.FS for the given hash.

func (*Repo) Refs

func (r *Repo) Refs(ctx context.Context, prefixes ...string) ([]ref, error)

Refs executes an ls-Refs command on the remote server to look up Refs with the given prefixes. See https://git-scm.com/docs/protocol-v2#_ls_refs.

func (*Repo) Resolve

func (r *Repo) Resolve(ctx context.Context, ref string) (Hash, error)

Resolve looks up the given ref and returns the corresponding Hash.