assets

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 git submodule).

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 .

Updating dir-index-html

Upstream: https://github.com/ipfs/dir-index-html

dir-index-html is a git submodule. To update, run the following commands from this directory.

> git -C dir-index-html pull
> git -C dir-index-html checkout vX.Y.Z # target version

Then, you'll need to commit the updated submodule before regenerating bindata.go. Otherwise, go generate will checkout the checked-in version of dir-index-html.

> git add dir-index-html
> git commit -m 'chore: update dir-index-html to vX.Y.Z'

Finally, re-generate the directory index HTML template, tidy, and amend the previous commit.

> go generate .
> git add bindata.go
> git add bindata_version_hash.go
> go mod tidy
> git commit --amend --no-edit

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 = "514e5ae28d8adb84955801b56ef47aca44bf9cc8"
)

Functions

func Asset

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

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

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

func AssetNames() []string

AssetNames returns the names of the assets.

func MustAsset

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

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively

func SeedInitDocs

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