xbcommon

package
v0.0.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 16, 2020 License: BSD-2-Clause, CC0-1.0 Imports: 23 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var BinaryDir = binary.BigEndian

Functions

func FilePath

func FilePath(pth ...string) string

Types

type Asset

type Asset interface {
	Node
	Reader() (iocommon.ReadSeekCloser, error)
	Digest() [sha256.Size]byte
	Data() ([]byte, error)
	DataS() (string, error)
	MustData() []byte
	MustDataS() string
}

type Assets

type Assets struct {
	Assets *map[string]Asset

	Factory func() (assets map[string]Asset, err error)

	local.LocalSourcesAttribute
	// contains filtered or unexported fields
}

func NewAssets

func NewAssets(assets ...Asset) *Assets

func (*Assets) Digests

func (assets *Assets) Digests() (map[string][sha256.Size]byte, error)

Digests returns a map of all known files and their checksums.

func (*Assets) Get

func (assets *Assets) Get(name string) (asset Asset, ok bool)

func (*Assets) GetC added in v0.0.5

func (assets *Assets) GetC(ctx context.Context, name string) (asset Asset, ok bool)

func (*Assets) MustGet added in v0.0.5

func (assets *Assets) MustGet(name string) (asset Asset)

func (*Assets) MustGetC added in v0.0.5

func (assets *Assets) MustGetC(ctx context.Context, name string) (asset Asset)

func (*Assets) Names

func (assets *Assets) Names() []string

Names returns the names of the assets.

func (*Assets) RestoreAsset

func (assets *Assets) RestoreAsset(dir, name string) (err error)

RestoreAsset restores an asset under the given directory.

func (*Assets) RestoreDir

func (assets *Assets) RestoreDir(dir, name string) (err error)

RestoreAssets restores an asset under the given directory recursively.

func (*Assets) Root

func (assets *Assets) Root() NodeDir

type Dir

type Dir struct {
	*DirInfo
	// contains filtered or unexported fields
}

func NewDir

func NewDir(depth int, pth string, children map[string]Node) *Dir

func (*Dir) Asset

func (t *Dir) Asset(name string) (a Asset)

func (*Dir) Child

func (t *Dir) Child(name string) (n Node)

func (*Dir) Depth

func (ic *Dir) Depth() int

func (*Dir) Dir

func (t *Dir) Dir(name string) (d NodeDir)

func (*Dir) Each

func (t *Dir) Each(cb func(name string, n Node) error) (err error)

func (*Dir) Get

func (t *Dir) Get(name string) (n Node, err error)

func (*Dir) GetChild

func (t *Dir) GetChild(name string) (n Node, ok bool)

func (*Dir) GetDir

func (t *Dir) GetDir(pth string) (d NodeDir, err error)

func (*Dir) Index

func (ic *Dir) Index() int

func (*Dir) Info

func (t *Dir) Info() os.FileInfo

func (*Dir) IsFirst

func (ic *Dir) IsFirst() bool

func (*Dir) IsLast

func (ic *Dir) IsLast() bool

func (*Dir) List

func (t *Dir) List() []Node

func (*Dir) Restore

func (t *Dir) Restore(baseDir string) (err error)

Restore restores an asset under the given directory.

func (*Dir) Save

func (t *Dir) Save(dest string) (err error)

func (*Dir) Walk

func (t *Dir) Walk(cb func(dir, name string, n Node, data interface{}) (interface{}, error)) (err error)

func (*Dir) WalkPrefix

func (t *Dir) WalkPrefix(prefix string, cb func(dir, name string, n Node, data interface{}) (interface{}, error), data interface{}) (err error)

type DirInfo

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

func (DirInfo) IsDir

func (DirInfo) IsDir() bool

func (DirInfo) ModTime

func (DirInfo) ModTime() (t time.Time)

func (DirInfo) Mode

func (DirInfo) Mode() os.FileMode

func (DirInfo) Name

func (b DirInfo) Name() string

func (DirInfo) Path

func (d DirInfo) Path() string

func (DirInfo) Size

func (DirInfo) Size() int64

func (DirInfo) Sys

func (DirInfo) Sys() interface{}

type File

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

func NewFile

func NewFile(fileInfo *FileInfo, reader func() (iocommon.ReadSeekCloser, error), digest *[sha256.Size]byte) *File

func (File) Data

func (f File) Data() ([]byte, error)

func (*File) DataS added in v0.0.5

func (f *File) DataS() (string, error)

func (*File) Depth

func (ic *File) Depth() int

func (*File) Digest

func (f *File) Digest() (d [sha256.Size]byte)

func (*File) ImportLocal added in v0.0.5

func (f *File) ImportLocal(localPath, name string, info os.FileInfo) (err error)

func (*File) Index

func (ic *File) Index() int

func (*File) IsFirst

func (ic *File) IsFirst() bool

func (*File) IsLast

func (ic *File) IsLast() bool

func (*File) MustData added in v0.0.5

func (f *File) MustData() []byte

func (*File) MustDataS added in v0.0.5

func (f *File) MustDataS() string

func (*File) Reader

func (f *File) Reader() (iocommon.ReadSeekCloser, error)

func (*File) Restore

func (f *File) Restore(baseDir string) (err error)

Restore restores an asset under the given directory.

func (*File) Save

func (f *File) Save(dest string) (err error)

type FileInfo

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

func NewFileInfo

func NewFileInfo(pth string, size int64, mode os.FileMode, modTime, changeTime time.Time) *FileInfo

func (*FileInfo) ChangeTime

func (fi *FileInfo) ChangeTime() time.Time

func (FileInfo) IsDir

func (fi FileInfo) IsDir() bool

func (*FileInfo) Marshal

func (fi *FileInfo) Marshal(w io.Writer) (err error)

func (*FileInfo) ModTime

func (fi *FileInfo) ModTime() time.Time

func (*FileInfo) Mode

func (fi *FileInfo) Mode() os.FileMode

func (*FileInfo) Name

func (fi *FileInfo) Name() string

func (*FileInfo) Path

func (fi *FileInfo) Path() string

func (*FileInfo) Size

func (fi *FileInfo) Size() int64

func (FileInfo) Sys

func (fi FileInfo) Sys() interface{}

func (*FileInfo) Unmarshal

func (fi *FileInfo) Unmarshal(r io.Reader) (err error)

type LocalFile added in v0.0.5

type LocalFile struct {
	*assetfs.RealFileInfo
	// contains filtered or unexported fields
}

func (*LocalFile) Depth added in v0.0.5

func (ic *LocalFile) Depth() int

func (LocalFile) Digest added in v0.0.5

func (f LocalFile) Digest() [sha256.Size]byte

func (*LocalFile) Index added in v0.0.5

func (ic *LocalFile) Index() int

func (*LocalFile) IsFirst added in v0.0.5

func (ic *LocalFile) IsFirst() bool

func (*LocalFile) IsLast added in v0.0.5

func (ic *LocalFile) IsLast() bool

func (LocalFile) Restore added in v0.0.5

func (f LocalFile) Restore(baseDir string) (err error)

func (LocalFile) Save added in v0.0.5

func (f LocalFile) Save(dest string) (err error)

type Node

type Node interface {
	os.FileInfo
	Path() string
	Save(dest string) (err error)
	Restore(baseDir string) (err error)
	Depth() int
	Index() int
	IsFirst() bool
	IsLast() bool
}

type NodeDir

type NodeDir interface {
	Node
	List() []Node
	Each(cb func(name string, n Node) error) error
	Get(name string) (n Node, err error)
	GetChild(name string) (n Node, ok bool)
	Child(name string) (n Node)
	Dir(name string) (n NodeDir)
	Asset(name string) (n Asset)
	Walk(cb func(dir, name string, n Node, data interface{}) (ret interface{}, err error)) (err error)
	WalkPrefix(prefix string, cb func(dir, name string, n Node, data interface{}) (ret interface{}, err error), data interface{}) (err error)
	GetDir(pth string) (d NodeDir, err error)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL