package
0.24.0
Repository: https://github.com/ipfs/boxo.git
Documentation: pkg.go.dev

# README

boxo/files

File interfaces and utils used in GO implementations of IPFS

Documentation

https://pkg.go.dev/github.com/ipfs/boxo/files

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?

License

MIT

# Functions

DirFromEntry calls ToDir on Node in the given entry.
No description provided by the author
FileFromEntry calls ToFile on Node in the given entry.
ModePermsToUnixPerms converts the permission bits of an os.FileMode to unix style mode permissions.
No description provided by the author
No description provided by the author
NewFileFromPartReader creates a Directory from a multipart reader.
NewFilter creates a new file filter from a .gitignore file and/or a list of ignore rules.
No description provided by the author
No description provided by the author
No description provided by the author
NewMultiFileReader constructs a MultiFileReader.
No description provided by the author
No description provided by the author
No description provided by the author
NewSerialFile takes a filepath, a bool specifying if hidden files should be included, and a fileInfo and returns a Node representing file, directory or special file.
NewSerialFileWith takes a filepath, a filter for determining which files should be operated upon if the filepath is a directory, and a fileInfo and returns a Node representing file, directory or special file.
No description provided by the author
No description provided by the author
No description provided by the author
NewTarWriter wraps given io.Writer into a new tar writer.
NewWebFile creates a WebFile with the given URL, which will be used to perform the GET request on Read().
ToDir is an alias for n.(Directory).
ToFile is an alias for n.(File).
No description provided by the author
UnixPermsOrDefault returns the unix style permissions stored for the given Node, or default unix permissions for the Node type.
UnixPermsToModePerms converts unix style mode permissions to os.FileMode permissions, as it only operates on permission bits it does not set the underlying type (fs.ModeDir, fs.ModeSymlink, etc.) in the returned os.FileMode.
UpdateFileMode sets the unix mode of the filesystem object referenced by path.
UpdateFileModeUnix sets the unix mode of the filesystem object referenced by path.
UpdateMeta sets the unix mode and modification time of the filesystem object referenced by path.
UpdateUnix sets the unix mode and modification time of the filesystem object referenced by path.
UpdateModTime sets the last access and modification time of the target filesystem object to the given time.
Walk walks a file tree, like `os.Walk`.
WriteTo writes the given node to the local filesystem at fpath.

# Constants

the HTTP Response header that provides the unix file mode.
the HTTP Response header that provides the last modified timestamp.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Filter represents a set of rules for determining if a file should be included or excluded.
MultiFileReader reads from a `commands.Node` (which can be a directory of files or a regular file) as HTTP multipart encoded data.
ReaderFile is a implementation of File created from an `io.Reader`.
SliceFile implements Node, and provides simple directory handling.
No description provided by the author
No description provided by the author
WebFile is an implementation of File which reads it from a Web URL (http).

# Interfaces

Directory is a special file which can link to any number of files.
DirEntry exposes information about a directory entry.
DirIterator is a iterator over directory entries.
Node represents a regular Unix file.
FileInfo exposes information on files in local filesystem.
Node is a common interface for files, directories and other special files.