package billy

Import Path
	github.com/go-git/go-billy/v5 (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 11 packages

Involved Source Files

	      fs.go
Package-Level Type Names (total 10, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Basic (interface)
		Basic abstract the basic operations in a storage-agnostic interface as
		an extension to the Basic interface.

		Methods (total 7, all are exported)
			( T) Create(filename string) (File, error)
				Create creates the named file with mode 0666 (before umask), truncating
				it if it already exists. If successful, methods on the returned File can
				be used for I/O; the associated file descriptor has mode O_RDWR.

			( T) Join(elem ...string) string
				Join joins any number of path elements into a single path, adding a
				Separator if necessary. Join calls filepath.Clean on the result; in
				particular, all empty strings are ignored. On Windows, the result is a
				UNC path if and only if the first path element is a UNC path.

			( T) Open(filename string) (File, error)
				Open opens the named file for reading. If successful, methods on the
				returned file can be used for reading; the associated file descriptor has
				mode O_RDONLY.

			( T) OpenFile(filename string, flag int, perm os.FileMode) (File, error)
				OpenFile is the generalized open call; most users will use Open or Create
				instead. It opens the named file with specified flag (O_RDONLY etc.) and
				perm, (0666 etc.) if applicable. If successful, methods on the returned
				File can be used for I/O.

			( T) Remove(filename string) error
				Remove removes the named file or directory.

			( T) Rename(oldpath, newpath string) error
				Rename renames (moves) oldpath to newpath. If newpath already exists and
				is not a directory, Rename replaces it. OS-specific restrictions may
				apply when oldpath and newpath are in different directories.

			( T) Stat(filename string) (os.FileInfo, error)
				Stat returns a FileInfo describing the named file.

		Implemented By (at least 4, all are exported)
			 Filesystem (interface)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			 github.com/go-git/go-billy/v5/helper/polyfill.Polyfill
			*github.com/go-git/go-billy/v5/osfs.OS
		As Outputs Of (at least 3, in which 2 are exported)
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).Underlying() Basic
			func github.com/go-git/go-billy/v5/helper/polyfill.(*Polyfill).Underlying() Basic
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/go-git/go-billy/v5/util.getUnderlyingAndPath(fs Basic, path string) (Basic, string)
		As Inputs Of (at least 9, in which 7 are exported)
			func Capabilities(fs Basic) Capability
			func CapabilityCheck(fs Basic, capabilities Capability) bool
			func github.com/go-git/go-billy/v5/helper/chroot.New(fs Basic, base string) Filesystem
			func github.com/go-git/go-billy/v5/helper/polyfill.New(fs Basic) Filesystem
			func github.com/go-git/go-billy/v5/util.RemoveAll(fs Basic, path string) error
			func github.com/go-git/go-billy/v5/util.TempFile(fs Basic, dir, prefix string) (f File, err error)
			func github.com/go-git/go-billy/v5/util.WriteFile(fs Basic, filename string, data []byte, perm os.FileMode) error
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func github.com/go-git/go-billy/v5/util.getUnderlyingAndPath(fs Basic, path string) (Basic, string)
			func github.com/go-git/go-billy/v5/util.removeAll(fs Basic, path string) error

	 type Capability uint64 (basic type)
		Capability holds the supported features of a billy filesystem. This does
		not mean that the capability has to be supported by the underlying storage.
		For example, a billy filesystem may support WriteCapability but the
		storage be mounted in read only mode.

		As Outputs Of (at least 5, all are exported)
			func Capabilities(fs Basic) Capability
			func Capable.Capabilities() Capability
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).Capabilities() Capability
			func github.com/go-git/go-billy/v5/helper/polyfill.(*Polyfill).Capabilities() Capability
			func github.com/go-git/go-billy/v5/osfs.(*OS).Capabilities() Capability
		As Inputs Of (at least one exported)
			func CapabilityCheck(fs Basic, capabilities Capability) bool
		As Types Of (total 8, all are exported)
			const AllCapabilities
			const DefaultCapabilities
			const LockCapability
			const ReadAndWriteCapability
			const ReadCapability
			const SeekCapability
			const TruncateCapability
			const WriteCapability

	 type Capable (interface)
		Capable interface can return the available features of a filesystem.

		Methods (only one, which is exported)
			( T) Capabilities() Capability
				Capabilities returns the capabilities of a filesystem in bit flags.

		Implemented By (at least 3, all are exported)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			*github.com/go-git/go-billy/v5/helper/polyfill.Polyfill
			*github.com/go-git/go-billy/v5/osfs.OS

	 type Change (interface)
		Change abstract the FileInfo change related operations in a storage-agnostic
		interface as an extension to the Basic interface

		Methods (total 4, all are exported)
			( T) Chmod(name string, mode os.FileMode) error
				Chmod changes the mode of the named file to mode. If the file is a
				symbolic link, it changes the mode of the link's target.

			( T) Chown(name string, uid, gid int) error
				Chown changes the numeric uid and gid of the named file. If the file is a
				symbolic link, it changes the uid and gid of the link's target.

			( T) Chtimes(name string, atime time.Time, mtime time.Time) error
				Chtimes changes the access and modification times of the named file,
				similar to the Unix utime() or utimes() functions.

				The underlying filesystem may truncate or round the values to a less
				precise time unit.

			( T) Lchown(name string, uid, gid int) error
				Lchown changes the numeric uid and gid of the named file. If the file is
				a symbolic link, it changes the uid and gid of the link itself.


	 type Chroot (interface)
		Chroot abstract the chroot related operations in a storage-agnostic interface
		as an extension to the Basic interface.

		Methods (total 2, both are exported)
			( T) Chroot(path string) (Filesystem, error)
				Chroot returns a new filesystem from the same type where the new root is
				the given path. Files outside of the designated directory tree cannot be
				accessed.

			( T) Root() string
				Root returns the root path of the filesystem.

		Implemented By (at least 3, all are exported)
			 Filesystem (interface)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			*github.com/go-git/go-billy/v5/helper/polyfill.Polyfill

	 type Dir (interface)
		Dir abstract the dir related operations in a storage-agnostic interface as
		an extension to the Basic interface.

		Methods (total 2, both are exported)
			( T) MkdirAll(filename string, perm os.FileMode) error
				MkdirAll creates a directory named path, along with any necessary
				parents, and returns nil, or else returns an error. The permission bits
				perm are used for all directories that MkdirAll creates. If path is/
				already a directory, MkdirAll does nothing and returns nil.

			( T) ReadDir(path string) ([]os.FileInfo, error)
				ReadDir reads the directory named by dirname and returns a list of
				directory entries sorted by filename.

		Implemented By (at least 4, all are exported)
			 Filesystem (interface)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			*github.com/go-git/go-billy/v5/helper/polyfill.Polyfill
			*github.com/go-git/go-billy/v5/osfs.OS
		As Inputs Of (at least one exported)
			func github.com/go-git/go-billy/v5/util.TempDir(fs Dir, dir, prefix string) (name string, err error)

	 type File (interface)
		File represent a file, being a subset of the os.File

		Methods (total 9, all are exported)
			( T) Close() error
			( T) Lock() error
				Lock locks the file like e.g. flock. It protects against access from
				other processes.

			( T) Name() string
				Name returns the name of the file as presented to Open.

			( T) Read(p []byte) (n int, err error)
			( T) ReadAt(p []byte, off int64) (n int, err error)
			( T) Seek(offset int64, whence int) (int64, error)
			( T) Truncate(size int64) error
				Truncate the file.

			( T) Unlock() error
				Unlock unlocks the file.

			( T) Write(p []byte) (n int, err error)
		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*github.com/go-git/go-billy/v5/helper/chroot.file
			*github.com/go-git/go-billy/v5/osfs.file
		Implements (at least 17, all are exported)
			 T : github.com/go-git/go-git/v5/plumbing/protocol/packp/sideband.Progress
			 T : github.com/jbenet/go-context/io.Reader
			 T : github.com/jbenet/go-context/io.Writer
			 T : io.Closer
			 T : io.ReadCloser
			 T : io.Reader
			 T : io.ReaderAt
			 T : io.ReadSeekCloser
			 T : io.ReadSeeker
			 T : io.ReadWriteCloser
			 T : io.ReadWriter
			 T : io.ReadWriteSeeker
			 T : io.Seeker
			 T : io.WriteCloser
			 T : io.Writer
			 T : io.WriteSeeker
			 T : mime/multipart.File
		As Outputs Of (at least 30, in which 27 are exported)
			func Basic.Create(filename string) (File, error)
			func Basic.Open(filename string) (File, error)
			func Basic.OpenFile(filename string, flag int, perm os.FileMode) (File, error)
			func Filesystem.Create(filename string) (File, error)
			func Filesystem.Open(filename string) (File, error)
			func Filesystem.OpenFile(filename string, flag int, perm os.FileMode) (File, error)
			func Filesystem.TempFile(dir, prefix string) (File, error)
			func TempFile.TempFile(dir, prefix string) (File, error)
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).Create(filename string) (File, error)
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).Open(filename string) (File, error)
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).OpenFile(filename string, flag int, mode os.FileMode) (File, error)
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).TempFile(dir, prefix string) (File, error)
			func github.com/go-git/go-billy/v5/helper/polyfill.(*Polyfill).TempFile(dir, prefix string) (File, error)
			func github.com/go-git/go-billy/v5/osfs.(*OS).Create(filename string) (File, error)
			func github.com/go-git/go-billy/v5/osfs.(*OS).Open(filename string) (File, error)
			func github.com/go-git/go-billy/v5/osfs.(*OS).OpenFile(filename string, flag int, perm os.FileMode) (File, error)
			func github.com/go-git/go-billy/v5/osfs.(*OS).TempFile(dir, prefix string) (File, error)
			func github.com/go-git/go-billy/v5/util.TempFile(fs Basic, dir, prefix string) (f File, err error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).Config() (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).ConfigWriter() (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).Index() (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).IndexWriter() (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).Object(h plumbing.Hash) (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).ObjectPack(hash plumbing.Hash) (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).ObjectPackIdx(hash plumbing.Hash) (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).Shallow() (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).ShallowWriter() (File, error)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func github.com/go-git/go-billy/v5/helper/chroot.newFile(fs Filesystem, f File, filename string) File
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).objectPackOpen(hash plumbing.Hash, extension string) (File, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).openAndLockPackedRefs(doCreate bool) (pr File, err error)
		As Inputs Of (at least 14, in which 4 are exported)
			func github.com/go-git/go-git/v5/plumbing/format/packfile.NewPackfile(index idxfile.Index, fs Filesystem, file File) *packfile.Packfile
			func github.com/go-git/go-git/v5/plumbing/format/packfile.NewPackfileWithCache(index idxfile.Index, fs Filesystem, file File, cache cache.Object) *packfile.Packfile
			func github.com/go-git/go-git/v5/storage/filesystem.NewPackfileIter(fs Filesystem, f File, idxFile File, t plumbing.ObjectType, keepPack bool) (storer.EncodedObjectIter, error)
			func github.com/go-git/go-git/v5/storage/filesystem.NewPackfileIter(fs Filesystem, f File, idxFile File, t plumbing.ObjectType, keepPack bool) (storer.EncodedObjectIter, error)
			/* 10+ unexporteds ... *//* 10+ unexporteds: */
			func github.com/go-git/go-billy/v5/helper/chroot.newFile(fs Filesystem, f File, filename string) File
			func github.com/go-git/go-git/v5/storage/filesystem.newPackfileIter(fs Filesystem, f File, t plumbing.ObjectType, seen map[plumbing.Hash]struct{}, index idxfile.Index, cache cache.Object, keepPack bool) (storer.EncodedObjectIter, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).addRefsFromPackedRefsFile(refs *[]*plumbing.Reference, f File, seen map[plumbing.ReferenceName]bool) (err error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).checkReferenceAndTruncate(f File, old *plumbing.Reference) error
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).copyNewFile(tmp File, pr File) (err error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).copyNewFile(tmp File, pr File) (err error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).copyToExistingFile(tmp, pr File) error
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).findPackedRefsInFile(f File) ([]*plumbing.Reference, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).rewritePackedRefsWhileLocked(tmp File, pr File) error
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).rewritePackedRefsWhileLocked(tmp File, pr File) error

	 type Filesystem (interface)
		Filesystem abstract the operations in a storage-agnostic interface.
		Each method implementation mimics the behavior of the equivalent functions
		at the os package from the standard library.

		Methods (total 15, all are exported)
			( T) Chroot(path string) (Filesystem, error)
				Chroot returns a new filesystem from the same type where the new root is
				the given path. Files outside of the designated directory tree cannot be
				accessed.

			( T) Create(filename string) (File, error)
				Create creates the named file with mode 0666 (before umask), truncating
				it if it already exists. If successful, methods on the returned File can
				be used for I/O; the associated file descriptor has mode O_RDWR.

			( T) Join(elem ...string) string
				Join joins any number of path elements into a single path, adding a
				Separator if necessary. Join calls filepath.Clean on the result; in
				particular, all empty strings are ignored. On Windows, the result is a
				UNC path if and only if the first path element is a UNC path.

			( T) Lstat(filename string) (os.FileInfo, error)
				Lstat returns a FileInfo describing the named file. If the file is a
				symbolic link, the returned FileInfo describes the symbolic link. Lstat
				makes no attempt to follow the link.

			( T) MkdirAll(filename string, perm os.FileMode) error
				MkdirAll creates a directory named path, along with any necessary
				parents, and returns nil, or else returns an error. The permission bits
				perm are used for all directories that MkdirAll creates. If path is/
				already a directory, MkdirAll does nothing and returns nil.

			( T) Open(filename string) (File, error)
				Open opens the named file for reading. If successful, methods on the
				returned file can be used for reading; the associated file descriptor has
				mode O_RDONLY.

			( T) OpenFile(filename string, flag int, perm os.FileMode) (File, error)
				OpenFile is the generalized open call; most users will use Open or Create
				instead. It opens the named file with specified flag (O_RDONLY etc.) and
				perm, (0666 etc.) if applicable. If successful, methods on the returned
				File can be used for I/O.

			( T) ReadDir(path string) ([]os.FileInfo, error)
				ReadDir reads the directory named by dirname and returns a list of
				directory entries sorted by filename.

			( T) Readlink(link string) (string, error)
				Readlink returns the target path of link.

			( T) Remove(filename string) error
				Remove removes the named file or directory.

			( T) Rename(oldpath, newpath string) error
				Rename renames (moves) oldpath to newpath. If newpath already exists and
				is not a directory, Rename replaces it. OS-specific restrictions may
				apply when oldpath and newpath are in different directories.

			( T) Root() string
				Root returns the root path of the filesystem.

			( T) Stat(filename string) (os.FileInfo, error)
				Stat returns a FileInfo describing the named file.

			( T) Symlink(target, link string) error
				Symlink creates a symbolic-link from link to target. target may be an
				absolute or relative path, and need not refer to an existing node.
				Parent directories of link are created as necessary.

			( T) TempFile(dir, prefix string) (File, error)
				TempFile creates a new temporary file in the directory dir with a name
				beginning with prefix, opens the file for reading and writing, and
				returns the resulting *os.File. If dir is the empty string, TempFile
				uses the default directory for temporary files (see os.TempDir).
				Multiple programs calling TempFile simultaneously will not choose the
				same file. The caller can use f.Name() to find the pathname of the file.
				It is the caller's responsibility to remove the file when no longer
				needed.

		Implemented By (at least 2, both are exported)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			*github.com/go-git/go-billy/v5/helper/polyfill.Polyfill
		Implements (at least 5, all are exported)
			 T : Basic
			 T : Chroot
			 T : Dir
			 T : Symlink
			 T : TempFile
		As Outputs Of (at least 12, in which 10 are exported)
			func Chroot.Chroot(path string) (Filesystem, error)
			func Filesystem.Chroot(path string) (Filesystem, error)
			func github.com/go-git/go-billy/v5/helper/chroot.New(fs Basic, base string) Filesystem
			func github.com/go-git/go-billy/v5/helper/chroot.(*ChrootHelper).Chroot(path string) (Filesystem, error)
			func github.com/go-git/go-billy/v5/helper/polyfill.New(fs Basic) Filesystem
			func github.com/go-git/go-billy/v5/helper/polyfill.(*Polyfill).Chroot(path string) (Filesystem, error)
			func github.com/go-git/go-billy/v5/osfs.New(baseDir string) Filesystem
			func github.com/go-git/go-git/v5/storage/filesystem.(*Storage).Filesystem() Filesystem
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).Fs() Filesystem
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.(*DotGit).Module(name string) (Filesystem, error)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func github.com/go-git/go-git/v5.dotGitFileToOSFilesystem(path string, fs Filesystem) (bfs Filesystem, err error)
			func github.com/go-git/go-git/v5.dotGitToOSFilesystems(path string, detect bool) (dot, wt Filesystem, err error)
		As Inputs Of (at least 33, in which 18 are exported)
			func github.com/go-git/go-billy/v5/util.Glob(fs Filesystem, pattern string) (matches []string, err error)
			func github.com/go-git/go-git/v5.Clone(s storage.Storer, worktree Filesystem, o *git.CloneOptions) (*git.Repository, error)
			func github.com/go-git/go-git/v5.CloneContext(ctx context.Context, s storage.Storer, worktree Filesystem, o *git.CloneOptions) (*git.Repository, error)
			func github.com/go-git/go-git/v5.Init(s storage.Storer, worktree Filesystem) (*git.Repository, error)
			func github.com/go-git/go-git/v5.Open(s storage.Storer, worktree Filesystem) (*git.Repository, error)
			func github.com/go-git/go-git/v5/plumbing/format/gitignore.LoadGlobalPatterns(fs Filesystem) (ps []gitignore.Pattern, err error)
			func github.com/go-git/go-git/v5/plumbing/format/gitignore.LoadSystemPatterns(fs Filesystem) (ps []gitignore.Pattern, err error)
			func github.com/go-git/go-git/v5/plumbing/format/gitignore.ReadPatterns(fs Filesystem, path []string) (ps []gitignore.Pattern, err error)
			func github.com/go-git/go-git/v5/plumbing/format/packfile.NewFSObject(hash plumbing.Hash, finalType plumbing.ObjectType, offset int64, contentSize int64, index idxfile.Index, fs Filesystem, path string, cache cache.Object) *packfile.FSObject
			func github.com/go-git/go-git/v5/plumbing/format/packfile.NewPackfile(index idxfile.Index, fs Filesystem, file File) *packfile.Packfile
			func github.com/go-git/go-git/v5/plumbing/format/packfile.NewPackfileWithCache(index idxfile.Index, fs Filesystem, file File, cache cache.Object) *packfile.Packfile
			func github.com/go-git/go-git/v5/plumbing/transport/server.NewFilesystemLoader(base Filesystem) server.Loader
			func github.com/go-git/go-git/v5/storage/filesystem.NewPackfileIter(fs Filesystem, f File, idxFile File, t plumbing.ObjectType, keepPack bool) (storer.EncodedObjectIter, error)
			func github.com/go-git/go-git/v5/storage/filesystem.NewStorage(fs Filesystem, cache cache.Object) *filesystem.Storage
			func github.com/go-git/go-git/v5/storage/filesystem.NewStorageWithOptions(fs Filesystem, cache cache.Object, ops filesystem.Options) *filesystem.Storage
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.New(fs Filesystem) *dotgit.DotGit
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.NewWithOptions(fs Filesystem, o dotgit.Options) *dotgit.DotGit
			func github.com/go-git/go-git/v5/utils/merkletrie/filesystem.NewRootNode(fs Filesystem, submodules map[string]plumbing.Hash) noder.Noder
			/* 15+ unexporteds ... *//* 15+ unexporteds: */
			func github.com/go-git/go-billy/v5/helper/chroot.newFile(fs Filesystem, f File, filename string) File
			func github.com/go-git/go-billy/v5/util.glob(fs Filesystem, dir, pattern string, matches []string) (m []string, e error)
			func github.com/go-git/go-billy/v5/util.readdirnames(fs Filesystem, dir string) ([]string, error)
			func github.com/go-git/go-git/v5.createDotGitFile(worktree, storage Filesystem) error
			func github.com/go-git/go-git/v5.doCleanDirectories(fs Filesystem, dir string) error
			func github.com/go-git/go-git/v5.dotGitFileToOSFilesystem(path string, fs Filesystem) (bfs Filesystem, err error)
			func github.com/go-git/go-git/v5.newRepository(s storage.Storer, worktree Filesystem) *git.Repository
			func github.com/go-git/go-git/v5.rmFileAndDirIfEmpty(fs Filesystem, name string) error
			func github.com/go-git/go-git/v5.setConfigWorktree(r *git.Repository, worktree, storage Filesystem) error
			func github.com/go-git/go-git/v5.setWorktreeAndStoragePaths(r *git.Repository, worktree Filesystem) error
			func github.com/go-git/go-git/v5/plumbing/format/gitignore.loadPatterns(fs Filesystem, path string) (ps []gitignore.Pattern, err error)
			func github.com/go-git/go-git/v5/plumbing/format/gitignore.readIgnoreFile(fs Filesystem, path []string, ignoreFile string) (ps []gitignore.Pattern, err error)
			func github.com/go-git/go-git/v5/storage/filesystem.newPackfileIter(fs Filesystem, f File, t plumbing.ObjectType, seen map[plumbing.Hash]struct{}, index idxfile.Index, cache cache.Object, keepPack bool) (storer.EncodedObjectIter, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.newObjectWriter(fs Filesystem) (*dotgit.ObjectWriter, error)
			func github.com/go-git/go-git/v5/storage/filesystem/dotgit.newPackWrite(fs Filesystem) (*dotgit.PackWriter, error)

	 type Symlink (interface)
		Symlink abstract the symlink related operations in a storage-agnostic
		interface as an extension to the Basic interface.

		Methods (total 3, all are exported)
			( T) Lstat(filename string) (os.FileInfo, error)
				Lstat returns a FileInfo describing the named file. If the file is a
				symbolic link, the returned FileInfo describes the symbolic link. Lstat
				makes no attempt to follow the link.

			( T) Readlink(link string) (string, error)
				Readlink returns the target path of link.

			( T) Symlink(target, link string) error
				Symlink creates a symbolic-link from link to target. target may be an
				absolute or relative path, and need not refer to an existing node.
				Parent directories of link are created as necessary.

		Implemented By (at least 4, all are exported)
			 Filesystem (interface)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			*github.com/go-git/go-billy/v5/helper/polyfill.Polyfill
			*github.com/go-git/go-billy/v5/osfs.OS

	 type TempFile (interface)

		Methods (only one, which is exported)
			( T) TempFile(dir, prefix string) (File, error)
				TempFile creates a new temporary file in the directory dir with a name
				beginning with prefix, opens the file for reading and writing, and
				returns the resulting *os.File. If dir is the empty string, TempFile
				uses the default directory for temporary files (see os.TempDir).
				Multiple programs calling TempFile simultaneously will not choose the
				same file. The caller can use f.Name() to find the pathname of the file.
				It is the caller's responsibility to remove the file when no longer
				needed.

		Implemented By (at least 4, all are exported)
			 Filesystem (interface)
			*github.com/go-git/go-billy/v5/helper/chroot.ChrootHelper
			*github.com/go-git/go-billy/v5/helper/polyfill.Polyfill
			*github.com/go-git/go-billy/v5/osfs.OS


Package-Level Functions (total 2, both are exported)

	 func Capabilities(fs Basic) Capability
		Capabilities returns the features supported by a filesystem. If the FS
		does not implement Capable interface it returns all features.

	 func CapabilityCheck(fs Basic, capabilities Capability) bool
		CapabilityCheck tests the filesystem for the provided capabilities and
		returns true in case it supports all of them.


Package-Level Variables (total 3, all are exported)

	  var ErrCrossedBoundary error
	  var ErrNotSupported error
	  var ErrReadOnly error
Package-Level Constants (total 8, all are exported)

	const AllCapabilities Capability = 63
		AllCapabilities lists all capable features.

	const DefaultCapabilities Capability = 63
		DefaultCapabilities lists all capable features supported by filesystems
		without Capability interface. This list should not be changed until a
		major version is released.

	const LockCapability Capability = 32
		LockCapability is the ability to lock a file.

	const ReadAndWriteCapability Capability = 4
		ReadAndWriteCapability is the ability to open a file in read and write mode.

	const ReadCapability Capability = 2
		ReadCapability means that the fs is readable.

	const SeekCapability Capability = 8
		SeekCapability means it is able to move position inside the file.

	const TruncateCapability Capability = 16
		TruncateCapability means that a file can be truncated.

	const WriteCapability Capability = 1
		WriteCapability means that the fs is writable.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.