stringfs

Documentation

Overview

The stringfs package provides a way to recursively encode the data in a directory as a string, and to extract the contents later.

Index

• func Encode(path string) (string, error)
• type FS
  • func Decode(s string) (*FS, error)
  • func (fs *FS) Open(path string) (*File, error)
• type File
  • func (f *File) IsDirectory() bool
  • func (f *File) Read(buf []byte) (int, error)
  • func (f *File) Readdirnames() ([]string, error)

Functions

func Encode

func Encode(path string) (string, error)

Encode recursively reads the directory at path and encodes it into a read only file system that can later be read with Decode.

Types

type FS

type FS struct {
	// contains filtered or unexported fields
}

FS represents the file system and all its data.

func Decode

func Decode(s string) (*FS, error)

Decode converts a file system as encoded by Encode into an FS.

func (*FS) Open

func (fs *FS) Open(path string) (*File, error)

Open opens the named path within fs. Paths are slash-separated, with an optional slash prefix.

type File

type File struct {
	// contains filtered or unexported fields
}

A File represents an entry in the file system.

func (*File) IsDirectory

func (f *File) IsDirectory() bool

IsDirectory returns true if the file represents a directory.

func (*File) Read

func (f *File) Read(buf []byte) (int, error)

Read reads from a file. It is invalid to call it on a directory.

func (*File) Readdirnames

func (f *File) Readdirnames() ([]string, error)

Readdirnames returns the names of all the files in the File, which must be a directory.