storagegit

Documentation

Overview

Package storagegit implements a storage abstraction for Git repositories.

Index

• type Provider
  • func NewProvider(objectReader git.ObjectReader, options ...ProviderOption) Provider
• type ProviderOption
  • func ProviderWithSymlinks() ProviderOption
• type ReadBucketOption
  • func ReadBucketWithSymlinksIfSupported() ReadBucketOption

Types

type Provider

type Provider interface {
	// NewReadBucket returns a new ReadBucket that represents
	// the state of the working tree at the particular tree.
	//
	// Typically, callers will want to source the tree from a commit, but
	// they can also use a subtree of another tree.
	NewReadBucket(hash git.Hash, options ...ReadBucketOption) (storage.ReadBucket, error)
}

Provider provides storage buckets for a git repository.

func NewProvider

func NewProvider(objectReader git.ObjectReader, options ...ProviderOption) Provider

NewProvider creates a new Provider for a git repository.

type ProviderOption

type ProviderOption func(*provider)

ProviderOption is an option for a new Provider.

func ProviderWithSymlinks

func ProviderWithSymlinks() ProviderOption

ProviderWithSymlinks returns a ProviderOption that results in symlink support.

Note that ReadBucketWithSymlinksIfSupported still needs to be passed for a given ReadBucket to have symlinks followed.

type ReadBucketOption

type ReadBucketOption func(*readBucketOptions)

ReadBucketOption is an option for a new ReadBucket.

func ReadBucketWithSymlinksIfSupported

func ReadBucketWithSymlinksIfSupported() ReadBucketOption

ReadBucketWithSymlinksIfSupported returns a ReadBucketOption that results in symlink support being enabled for this bucket. If the Provider did not have symlink support, this is a no-op.