repofs

Documentation

Index

• type FS
  • func NewFS(repoPath string) (FS, error)
• type FileHandle
  • func Bytes(content []byte) FileHandle
  • func String(content string) FileHandle
• type FsFileHandle
  • func (o FsFileHandle) Close() error
  • func (o FsFileHandle) Get() (io.ReadCloser, error)
  • func (o FsFileHandle) Put(src io.Reader) error

Types

type FS

type FS interface {
	fs.FS

	// IsDirty returns true if there are uncommitted changes.
	IsDirty() (bool, error)
	// GetStagedChanges returns a string containing the staged changes as a diff.
	GetStagedChanges() (string, error)
	// GetUncommittedChanges returns a string containing the uncommitted changes as a diff.
	GetUncommittedChanges() (string, error)
	// Checkout checks out the given commit.
	Checkout(commit string) error
	// Commit commits the changes with the given message.
	Commit(message string) (commitId string, err error)
	// Push pushes the changes to the remote repository.
	Push() error
	// StageAll stages all the changes.
	StageAll() error

	// Path returns the path to the repository.
	Path() string
}

func NewFS

func NewFS(repoPath string) (FS, error)

type FileHandle

type FileHandle interface {
	Get() (io.ReadCloser, error)
	Put(src io.Reader) error
	Close() error
}

func Bytes

func Bytes(content []byte) FileHandle

func String

func String(content string) FileHandle

type FsFileHandle

type FsFileHandle struct {
	FS   fs.FS
	Path string
}

func (FsFileHandle) Close

func (o FsFileHandle) Close() error

func (FsFileHandle) Get

func (o FsFileHandle) Get() (io.ReadCloser, error)

func (FsFileHandle) Put

func (o FsFileHandle) Put(src io.Reader) error