README
¶
httpdir
-- import "vimagination.zapto.org/httpdir"
Package httpdir provides an in-memory implementation of http.FileSystem
Usage
const (
ModeDir fs.FileMode = fs.ModeDir | 0o755
ModeFile fs.FileMode = 0o644
)
Convenient FileMode constants
var Default = New(time.Now())
Default is the Dir used by the top-level functions
func Create
func Create(name string, n Node) error
Create is a convenience function for Default.Create
func Mkdir
func Mkdir(name string, modTime time.Time, index bool) error
Mkdir is a convenience function for Default.Mkdir
func Remove
func Remove(name string) error
Remove is a convenience function for Default.Remove
type Dir
type Dir struct {
}
Dir is the start of a simple in-memory filesystem tree
func New
func New(t time.Time) Dir
New creates a new, initialised, Dir
func (Dir) Create
func (d Dir) Create(name string, n Node) error
Create places a Node into the directory tree.
Any non-existent directories will be created automatically, setting the modTime to that of the Node and the index to false.
If you want to specify alternate modTime/index values for the directories, then you should create them first with Mkdir
func (Dir) Mkdir
func (d Dir) Mkdir(name string, modTime time.Time, index bool) error
Mkdir creates the named directory, and any parent directories required.
modTime is the modification time of the directory, used in caching mechanisms.
index specifies whether or not the directory allows a directory listing. NB: if the directory contains an index.html file, then that will be displayed instead, regardless the value of index.
All directories created will be given the specified modification time and index bool.
Directories already existing will not be modified.
func (Dir) Open
func (d Dir) Open(name string) (http.File, error)
Open returns the file, or directory, specified by the given name.
This method is the implementation of http.FileSystem and isn't intended to be used by clients of this package.
func (Dir) Remove
func (d Dir) Remove(name string) error
Remove will remove a node from the tree.
It will remove files and any directories, whether they are empty or not.
Caution: httpdir does no internal locking, so you should provide your own if you intend to call this method.
type File
type File interface {
io.Reader
io.Seeker
io.Closer
Readdir(int) ([]fs.FileInfo, error)
}
File represents an opened data Node
type Node
type Node interface {
Size() int64
Mode() fs.FileMode
ModTime() time.Time
Open() (File, error)
}
Node represents a data file in the tree
func FileBytes
func FileBytes(data []byte, modTime time.Time) Node
FileBytes provides an implementation of Node that takes a byte slice as its data source
func FileString
func FileString(data string, modTime time.Time) Node
FileString provides an implementation of Node that takes a string as its data source
type OSFile
type OSFile string
OSFile is the path of a file in the real filesystem to be put into the im-memory filesystem
func (OSFile) ModTime
func (o OSFile) ModTime() time.Time
ModTime returns the ModTime of the file
func (OSFile) Mode
func (o OSFile) Mode() fs.FileMode
Mode returns the Mode of the file
func (OSFile) Open
func (o OSFile) Open() (File, error)
Open opens the file, returning it as a File
func (OSFile) Size
func (o OSFile) Size() int64
Size returns the size of the file
Documentation
¶
Overview ¶
Package httpdir provides an in-memory implementation of http.FileSystem
Index ¶
Constants ¶
Convenient FileMode constants
Variables ¶
var Default = New(time.Now())
Default is the Dir used by the top-level functions
Functions ¶
Types ¶
type Dir ¶
type Dir struct {
// contains filtered or unexported fields
}
Dir is the start of a simple in-memory filesystem tree
func (Dir) Create ¶
Create places a Node into the directory tree.
Any non-existent directories will be created automatically, setting the modTime to that of the Node and the index to false.
If you want to specify alternate modTime/index values for the directories, then you should create them first with Mkdir
func (Dir) Mkdir ¶
Mkdir creates the named directory, and any parent directories required.
modTime is the modification time of the directory, used in caching mechanisms.
index specifies whether or not the directory allows a directory listing. NB: if the directory contains an index.html file, then that will be displayed instead, regardless the value of index.
All directories created will be given the specified modification time and index bool.
Directories already existing will not be modified.
type Node ¶
Node represents a data file in the tree
Source Files
Directories