package chroot

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

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	      chroot.go
Package-Level Type Names (total 2, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ChrootHelper (struct)
		ChrootHelper is a helper to implement billy.Chroot.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			base string
			underlying billy.Filesystem
		Methods (total 18, in which 17 are exported)
			(*T) Capabilities() billy.Capability
				Capabilities implements the Capable interface.

			(*T) Chroot(path string) (billy.Filesystem, error)
			(*T) Create(filename string) (billy.File, error)
			(*T) Join(elem ...string) string
			(*T) Lstat(filename string) (os.FileInfo, error)
			(*T) MkdirAll(filename string, perm os.FileMode) error
			(*T) Open(filename string) (billy.File, error)
			(*T) OpenFile(filename string, flag int, mode os.FileMode) (billy.File, error)
			(*T) ReadDir(path string) ([]os.FileInfo, error)
			(*T) Readlink(link string) (string, error)
			(*T) Remove(path string) error
			(*T) Rename(from, to string) error
			(*T) Root() string
			(*T) Stat(filename string) (os.FileInfo, error)
			(*T) Symlink(target, link string) error
			(*T) TempFile(dir, prefix string) (billy.File, error)
			(*T) Underlying() billy.Basic
			/* one unexported ... *//* one unexported: */
			(*T) underlyingPath(filename string) (string, error)
		Implements (at least 8, in which 7 are exported)
			*T : github.com/go-git/go-billy/v5.Basic
			*T : github.com/go-git/go-billy/v5.Capable
			*T : github.com/go-git/go-billy/v5.Chroot
			*T : github.com/go-git/go-billy/v5.Dir
			*T : github.com/go-git/go-billy/v5.Filesystem
			*T : github.com/go-git/go-billy/v5.Symlink
			*T : github.com/go-git/go-billy/v5.TempFile
			/* at least one unexported ... *//* at least one unexported: */
			*T : github.com/go-git/go-billy/v5/util.underlying

	/* one unexported ... *//* one unexported: */
	 type file (struct)

		Fields (total 2, in which 1 are exported)
			File billy.File
			/* one unexported ... *//* one unexported: */
			name string
		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
			( 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)
		Implements (at least 18, all are exported)
			*T : github.com/go-git/go-billy/v5.File
			 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


Package-Level Functions (total 3, in which 1 are exported)

	 func New(fs billy.Basic, base string) billy.Filesystem
		New creates a new filesystem wrapping up the given 'fs'.
		The created filesystem has its base in the given ChrootHelperectory of the
		underlying filesystem.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func isCrossBoundaries(path string) bool
	 func newFile(fs billy.Filesystem, f billy.File, filename string) billy.File

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.