Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // DeterministicFileModificationTimestamp is a fixed timestamp that // can be provided to Directory.Chtimes() to give files deterministic // modification times. It is used by bb_worker to ensure that all // files in the input root of a build action have the same // modification time. This is needed to make certain kinds of build // actions (most notably Autoconf scripts) succeed. // // 2000-01-01T00:00:00Z was chosen, because it's easy to distinguish // from genuine timestamps. 1970-01-01T00:00:00Z would be impractical // to use, because it tends to cause regressions in practice. // // Examples: // https://bugs.python.org/issue34097 // https://gerrit.wikimedia.org/r/#/c/mediawiki/core/+/437977/ DeterministicFileModificationTimestamp = time.Date(2000, time.January, 1, 0, 0, 0, 0, time.UTC) )
var ( // DontCreate indicates that opening should fail in case the // target file does not exist. DontCreate = CreationMode{} )
Functions ¶
This section is empty.
Types ¶
type CreationMode ¶
type CreationMode struct {
// contains filtered or unexported fields
}
CreationMode specifies whether and how Directory.Open*() should create new files.
func CreateExcl ¶
func CreateExcl(perm os.FileMode) CreationMode
CreateExcl indicates that a new file should be created. If the target file already exists, opening shall fail.
func CreateReuse ¶
func CreateReuse(perm os.FileMode) CreationMode
CreateReuse indicates that a new file should be created if it doesn't already exist. If the target file already exists, that file will be opened instead.
func (CreationMode) GetPermissions ¶
func (c CreationMode) GetPermissions() os.FileMode
GetPermissions returns the file permissions the newly created file should have.
func (CreationMode) ShouldCreate ¶
func (c CreationMode) ShouldCreate() bool
ShouldCreate returns whether a new file should be created if it doesn't exist yet.
func (CreationMode) ShouldFailWhenExists ¶
func (c CreationMode) ShouldFailWhenExists() bool
ShouldFailWhenExists returns whether a new file must be created. When true, opening must fail in case the target file already exists.
type Directory ¶
type Directory interface {
// EnterDirectory creates a derived directory handle for a
// subdirectory of the current subtree.
EnterDirectory(name string) (DirectoryCloser, error)
// Open a file contained within the directory for writing, only
// allowing data to be appended to the end of the file.
OpenAppend(name string, creationMode CreationMode) (FileAppender, error)
// Open a file contained within the directory for reading. The
// CreationMode is assumed to be equal to DontCreate.
OpenRead(name string) (FileReader, error)
// Open a file contained within the current directory for both
// reading and writing.
OpenReadWrite(name string, creationMode CreationMode) (FileReadWriter, error)
// Open a file contained within the current directory for writing.
OpenWrite(name string, creationMode CreationMode) (FileWriter, error)
// Link is the equivalent of os.Link().
Link(oldName string, newDirectory Directory, newName string) error
// Lstat is the equivalent of os.Lstat().
Lstat(name string) (FileInfo, error)
// Mkdir is the equivalent of os.Mkdir().
Mkdir(name string, perm os.FileMode) error
// Mknod is the equivalent of unix.Mknod().
Mknod(name string, perm os.FileMode, dev int) error
// ReadDir is the equivalent of ioutil.ReadDir().
ReadDir() ([]FileInfo, error)
// Readlink is the equivalent of os.Readlink().
Readlink(name string) (string, error)
// Remove is the equivalent of os.Remove().
Remove(name string) error
// RemoveAll is the equivalent of os.RemoveAll().
RemoveAll(name string) error
// RemoveAllChildren empties out a directory, without removing
// the directory itself.
RemoveAllChildren() error
// Symlink is the equivalent of os.Symlink().
Symlink(oldName string, newName string) error
// Chtimes sets the atime and mtime of the named file.
Chtimes(name string, atime, mtime time.Time) error
// Function that base types may use to implement calls that
// require double dispatching, such as hardlinking and renaming.
Apply(arg interface{}) error
}
Directory is an abstraction for accessing a subtree of the file system. Each of the functions should be implemented in such a way that they reject access to data stored outside of the subtree. This allows for safe, race-free traversal of the file system.
By placing this in a separate interface, it's easier to stub out file system handling as part of unit tests entirely.
type DirectoryCloser ¶
DirectoryCloser is a Directory handle that can be released.
func NewLocalDirectory ¶
func NewLocalDirectory(path string) (DirectoryCloser, error)
NewLocalDirectory creates a directory handle that corresponds to a local path on the system.
func NopDirectoryCloser ¶
func NopDirectoryCloser(d Directory) DirectoryCloser
NopDirectoryCloser adds a no-op Close method to a Directory object, similar to how ioutil.NopCloser() adds a Close method to a Reader.
type FileAppender ¶
FileAppender is returned by Directory.OpenAppend(). It is a handle for a file that only permits new data to be written to the end.
type FileInfo ¶
type FileInfo struct {
// contains filtered or unexported fields
}
FileInfo is a subset of os.FileInfo, only containing the features used by the Buildbarn codebase.
func NewFileInfo ¶
NewFileInfo constructs a FileInfo object that returns fixed values for its methods.
type FileInfoList ¶
type FileInfoList []FileInfo
FileInfoList is a list of FileInfo objects returned by Directory.ReadDir(). This type may be used to sort elements in the list by name.
func (FileInfoList) Len ¶
func (l FileInfoList) Len() int
func (FileInfoList) Swap ¶
func (l FileInfoList) Swap(i int, j int)
type FileReadWriter ¶
FileReadWriter is returned by Directory.OpenReadWrite(). It is a handle for a file that permits data to be read from and written to arbitrary locations.
type FileReader ¶
FileReader is returned by Directory.OpenRead(). It is a handle for a file that permits data to be read from arbitrary locations.
type FileType ¶
type FileType int
FileType is an enumeration of the type of a file stored on a file system.
const ( // FileTypeRegularFile means the file is a regular file that is // not executable. FileTypeRegularFile FileType = iota // FileTypeExecutableFile means the file is a regular file that // is executable. FileTypeExecutableFile // FileTypeDirectory means the file is a directory. FileTypeDirectory // FileTypeSymlink means the file is a symbolic link. FileTypeSymlink // FileTypeOther means the file is neither a regular file, a // directory or symbolic link. FileTypeOther )
Source Files