README
¶
go-ipfs-files
File interfaces and utils used in IPFS
Documentation
https://godoc.org/github.com/ipfs/go-ipfs-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
Documentation
¶
Index ¶
- Variables
- func IsHidden(f File) bool
- type File
- type FileInfo
- type MultiFileReader
- type MultipartFile
- type PeekFile
- type ReaderFile
- func (f *ReaderFile) AbsPath() string
- func (f *ReaderFile) Close() error
- func (f *ReaderFile) FileName() string
- func (f *ReaderFile) FullPath() string
- func (f *ReaderFile) IsDirectory() bool
- func (f *ReaderFile) NextFile() (File, error)
- func (f *ReaderFile) Read(p []byte) (int, error)
- func (f *ReaderFile) Size() (int64, error)
- func (f *ReaderFile) Stat() os.FileInfo
- type SizeFile
- type SliceFile
- func (f *SliceFile) Close() error
- func (f *SliceFile) FileName() string
- func (f *SliceFile) FullPath() string
- func (f *SliceFile) IsDirectory() bool
- func (f *SliceFile) Length() int
- func (f *SliceFile) NextFile() (File, error)
- func (f *SliceFile) Peek(n int) File
- func (f *SliceFile) Read(p []byte) (int, error)
- func (f *SliceFile) Size() (int64, error)
- type StatFile
- type Symlink
- type WebFile
Constants ¶
This section is empty.
Variables ¶
var ( ErrNotDirectory = errors.New("Couldn't call NextFile(), this isn't a directory") ErrNotReader = errors.New("This file is a directory, can't use Reader functions") )
Functions ¶
Types ¶
type File ¶
type File interface {
// Files implement ReadCloser, but can only be read from or closed if
// they are not directories
io.ReadCloser
// FileName returns a filename associated with this file
FileName() string
// FullPath returns the full path used when adding with this file
FullPath() string
// IsDirectory returns true if the File is a directory (and therefore
// supports calling `NextFile`) and false if the File is a normal file
// (and therefor supports calling `Read` and `Close`)
IsDirectory() bool
// NextFile returns the next child file available (if the File is a
// directory). It will return (nil, io.EOF) if no more files are
// available. If the file is a regular file (not a directory), NextFile
// will return a non-nil error.
NextFile() (File, error)
}
File is an interface that provides functionality for handling files/directories as values that can be supplied to commands. For directories, child files are accessed serially by calling `NextFile()`.
type MultiFileReader ¶
MultiFileReader reads from a `commands.File` (which can be a directory of files or a regular file) as HTTP multipart encoded data.
func NewMultiFileReader ¶
func NewMultiFileReader(file File, form bool) *MultiFileReader
NewMultiFileReader constructs a MultiFileReader. `file` can be any `commands.File`. If `form` is set to true, the multipart data will have a Content-Type of 'multipart/form-data', if `form` is false, the Content-Type will be 'multipart/mixed'.
func (*MultiFileReader) Boundary ¶
func (mfr *MultiFileReader) Boundary() string
Boundary returns the boundary string to be used to separate files in the multipart data
type MultipartFile ¶
MultipartFile implements File, and is created from a `multipart.Part`. It can be either a directory or file (checked by calling `IsDirectory()`).
func (*MultipartFile) Close ¶
func (f *MultipartFile) Close() error
func (*MultipartFile) FileName ¶
func (f *MultipartFile) FileName() string
func (*MultipartFile) FullPath ¶
func (f *MultipartFile) FullPath() string
func (*MultipartFile) IsDirectory ¶
func (f *MultipartFile) IsDirectory() bool
func (*MultipartFile) NextFile ¶
func (f *MultipartFile) NextFile() (File, error)
type ReaderFile ¶
type ReaderFile struct {
// contains filtered or unexported fields
}
ReaderFile is a implementation of File created from an `io.Reader`. ReaderFiles are never directories, and can be read from and closed.
func NewReaderFile ¶
func NewReaderFile(filename, path string, reader io.ReadCloser, stat os.FileInfo) *ReaderFile
func NewReaderPathFile ¶
func NewReaderPathFile(filename, path string, reader io.ReadCloser, stat os.FileInfo) (*ReaderFile, error)
func (*ReaderFile) AbsPath ¶
func (f *ReaderFile) AbsPath() string
func (*ReaderFile) Close ¶
func (f *ReaderFile) Close() error
func (*ReaderFile) FileName ¶
func (f *ReaderFile) FileName() string
func (*ReaderFile) FullPath ¶
func (f *ReaderFile) FullPath() string
func (*ReaderFile) IsDirectory ¶
func (f *ReaderFile) IsDirectory() bool
func (*ReaderFile) NextFile ¶
func (f *ReaderFile) NextFile() (File, error)
func (*ReaderFile) Size ¶
func (f *ReaderFile) Size() (int64, error)
func (*ReaderFile) Stat ¶
func (f *ReaderFile) Stat() os.FileInfo
type SliceFile ¶
type SliceFile struct {
// contains filtered or unexported fields
}
SliceFile implements File, and provides simple directory handling. It contains children files, and is created from a `[]File`. SliceFiles are always directories, and can't be read from or closed.
func NewSliceFile ¶
func (*SliceFile) IsDirectory ¶
type Symlink ¶
type Symlink struct {
Target string
// contains filtered or unexported fields
}
func (*Symlink) IsDirectory ¶
type WebFile ¶
type WebFile struct {
// contains filtered or unexported fields
}
WebFile is an implementation of File which reads it from a Web URL (http). A GET request will be performed against the source when calling Read().
func NewWebFile ¶
NewWebFile creates a WebFile with the given URL, which will be used to perform the GET request on Read().
Source Files