Categorygithub.com/ipfs/go-commands
modulepackage
0.0.0-20200428221829-30dfa19b8f78
Repository: https://github.com/ipfs/go-commands.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
14
Dependents
2
Files
898 SLOC

# README

[DEPRECATED] go-commands

standard-readme compliant

(Deprecated) Commands library for go-ipfs

IMPORTANT! This repository is dead and has long been continued within go-ipfs.

Table of Contents

Install

TODO

Usage

TODO

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?

License

MIT

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewEmptyRequest initializes an empty request.
constructor helper functions.
NewRequest returns a request initialized with given arguments An non-nil error will be returned if the provided option values are invalid.
NewResponse returns a response to match given Request.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
Types of Command options.
Flag names.
Flag names.
Flag names.
error was caused by the client, (e.g.
programmer error in the server.
general errors.
Types of Command options.
Types of Command options.
Types of Command options.
Supported EncodingType constants.
Flag names.
Flag names.
Types of Command options.
Text
Supported EncodingType constants.
Flag names.
Types of Command options.
Supported EncodingType constants.

# Variables

No description provided by the author
No description provided by the author
ErrNotCallable signals a command that cannot be called.
options that are used by this package.
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
Command is a runnable command, with input arguments and options (flags).
Error is a struct for marshalling errors.
HelpText is a set of strings used to generate command help text.
No description provided by the author

# Interfaces

Option is used to specify a field that will be provided by a consumer.
Request represents a call to a command from a consumer.
Response is the result of a command request.

# Type aliases

No description provided by the author
EncodingType defines a supported encoding.
ErrorType signfies a category of errors.
Function is the type of function that Commands use.
Marshaler is a function that takes in a Response, and returns an io.Reader (or an error on failure).
MarshalerMap is a map of Marshaler functions, keyed by EncodingType (or an error on failure).
No description provided by the author