README
¶
Assets loaded in with IPFS
This directory contains the go-ipfs assets:
- Getting started documentation (
init-doc
). - Directory listing HTML template (
dir-index-html
).
These assets are compiled into bindata.go
with go generate
.
Re-generating
Do not edit the .go files directly.
Instead, edit the source files and use go generate
from within the
assets directory:
go generate .
Documentation
¶
Overview ¶
Package assets generated by go-bindata.// sources: init-doc/about init-doc/contact init-doc/help init-doc/ping init-doc/quick-start init-doc/readme init-doc/security-notes dir-index-html/dir-index.html dir-index-html/knownIcons.txt
File generated together with 'bindata.go' when running `go generate .` DO NOT EDIT. (@generated)
Index ¶
- Constants
- func Asset(name string) ([]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func MustAsset(name string) []byte
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- func SeedInitDocs(nd *core.IpfsNode) (cid.Cid, error)
Constants ¶
const (
BindataVersionHash = "512eb789cd905714e03f29d4e04de7549e8c9c3e"
)
Variables ¶
This section is empty.
Functions ¶
func Asset ¶ added in v0.3.6
func Asset(name string) ([]byte, error)
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDir ¶ added in v0.3.6
func AssetDir(name string) ([]string, error)
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/ foo.txt img/ a.png b.png
then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.
func AssetInfo ¶ added in v0.3.6
func AssetInfo(name string) (os.FileInfo, error)
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetNames ¶ added in v0.3.6
func AssetNames() []string
AssetNames returns the names of the assets.
func MustAsset ¶ added in v0.3.6
func MustAsset(name string) []byte
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func RestoreAsset ¶ added in v0.3.6
func RestoreAsset(dir, name string) error
RestoreAsset restores an asset under the given directory
func RestoreAssets ¶ added in v0.3.6
func RestoreAssets(dir, name string) error
RestoreAssets restores an asset under the given directory recursively
func SeedInitDocs ¶ added in v0.3.6
func SeedInitDocs(nd *core.IpfsNode) (cid.Cid, error)
SeedInitDocs adds the list of embedded init documentation to the passed node, pins it and returns the root key
Types ¶
This section is empty.