Documentation
¶
Index ¶
- Variables
- func CidBaseDefined(req *cmds.Request) bool
- func CidEncoderFromPath(p string) (cidenc.Encoder, error)
- func DownloadAndRebuildFile(req *cmds.Request, res cmds.ResponseEmitter, api coreiface.CoreAPI, ...) error
- func GetApi(env cmds.Environment, req *cmds.Request, opts ...options.ApiOption) (coreiface.CoreAPI, error)
- func GetCidEncoder(req *cmds.Request) (cidenc.Encoder, error)
- func GetCompressLevel(cmprs bool, cmplvl int) (int, error)
- func GetConfig(env cmds.Environment) (*config.Config, error)
- func GetConfigRoot(env cmds.Environment) (string, error)
- func GetFile(req *cmds.Request, res cmds.ResponseEmitter, api coreiface.CoreAPI, ...) (io.Reader, error)
- func GetFileArg(it files.DirIterator) (files.File, error)
- func GetLowLevelCidEncoder(req *cmds.Request) (cidenc.Encoder, error)
- func GetNode(env interface{}) (*core.IpfsNode, error)
- func RmPin(req *cmds.Request, res cmds.ResponseEmitter, n *core.IpfsNode, ...) error
- type PinOutput
Constants ¶
This section is empty.
Variables ¶
var DefaultBufSize = 1048576
DefaultBufSize is the buffer size for gets. for now, 1MB, which is ~4 blocks. TODO: does this need to be configurable?
var ErrInvalidCompressionLevel = errors.New("compression level must be between 1 and 9")
var OptionCidBase = cmds.StringOption("cid-base", "Multibase encoding used for version 1 CIDs in output.")
var OptionUpgradeCidV0InOutput = cmds.BoolOption("upgrade-cidv0-in-output", "Upgrade version 0 to version 1 CIDs in output.")
Functions ¶
func CidBaseDefined ¶
CidBaseDefined returns true if the `cid-base` option is specified on the command line
func CidEncoderFromPath ¶
CidEncoderFromPath creates a new encoder that is influenced from the encoded Cid in a Path. For CidV0 the multibase from the base encoder is used and automatic upgrades are disabled. For CidV1 the multibase from the CID is used and upgrades are enabled.
This logic is intentionally fuzzy and will match anything of the form `CidLike`, `CidLike/...`, or `/namespace/CidLike/...`.
For example:
* Qm... * Qm.../... * /ipfs/Qm... * /ipns/bafybeiahnxfi7fpmr5wtxs2imx4abnyn7fdxeiox7xxjem6zuiioqkh6zi/... * /bzz/bafybeiahnxfi7fpmr5wtxs2imx4abnyn7fdxeiox7xxjem6zuiioqkh6zi/...
func DownloadAndRebuildFile ¶
func GetApi ¶
func GetApi(env cmds.Environment, req *cmds.Request, opts ...options.ApiOption) (coreiface.CoreAPI, error)
GetApi extracts CoreAPI instance from the environment.
func GetCidEncoder ¶
GetCidEncoder processes the `cid-base` and `output-cidv1` options and returns a encoder to use based on those parameters.
func GetConfig ¶
func GetConfig(env cmds.Environment) (*config.Config, error)
GetConfig extracts the config from the environment.
func GetConfigRoot ¶
func GetConfigRoot(env cmds.Environment) (string, error)
GetConfigRoot extracts the config root from the environment
func GetFileArg ¶
func GetFileArg(it files.DirIterator) (files.File, error)
GetFileArg returns the next file from the directory or an error
func GetLowLevelCidEncoder ¶
GetLowLevelCidEncoder is like GetCidEncoder but meant to be used by lower level commands. It differs from GetCidEncoder in that CIDv0 are not, by default, auto-upgraded to CIDv1.
Source Files