Documentation
¶
Index ¶
- Constants
- Variables
- type BlockPutOption
- type BlockPutSettings
- type BlockRmOption
- type BlockRmSettings
- type DagPutOption
- type DagPutSettings
- type DagTreeOption
- type DagTreeSettings
- type DhtFindProvidersOption
- type DhtFindProvidersSettings
- type DhtProvideOption
- type DhtProvideSettings
- type KeyGenerateOption
- type KeyGenerateSettings
- type KeyRenameOption
- type KeyRenameSettings
- type Layout
- type NamePublishOption
- type NamePublishSettings
- type NameResolveOption
- type NameResolveSettings
- type ObjectAddLinkOption
- type ObjectAddLinkSettings
- type ObjectNewOption
- type ObjectNewSettings
- type ObjectPutOption
- type ObjectPutSettings
- type PinAddOption
- type PinAddSettings
- type PinLsOption
- type PinLsSettings
- type PinUpdateOption
- type PinUpdateSettings
- type PubSubPeersOption
- type PubSubPeersSettings
- type PubSubSubscribeOption
- type PubSubSubscribeSettings
- type UnixfsAddOption
- type UnixfsAddSettings
Constants ¶
View Source
const (
RSAKey = "rsa"
Ed25519Key = "ed25519"
DefaultRSALen = 2048
)
View Source
const (
DefaultNameValidTime = 24 * time.Hour
)
Variables ¶
View Source
var Block blockOpts
View Source
var Dag dagOpts
View Source
var Dht dhtOpts
View Source
var Key keyOpts
View Source
var Name nameOpts
View Source
var Object objectOpts
View Source
var Pin pinOpts
View Source
var PubSub pubsubOpts
View Source
var Unixfs unixfsOpts
Functions ¶
This section is empty.
Types ¶
type BlockPutOption ¶
type BlockPutOption func(*BlockPutSettings) error
type BlockPutSettings ¶
type BlockPutSettings struct {
Codec string
MhType uint64
MhLength int
}
func BlockPutOptions ¶
func BlockPutOptions(opts ...BlockPutOption) (*BlockPutSettings, cid.Prefix, error)
type BlockRmOption ¶
type BlockRmOption func(*BlockRmSettings) error
type BlockRmSettings ¶
type BlockRmSettings struct {
Force bool
}
func BlockRmOptions ¶
func BlockRmOptions(opts ...BlockRmOption) (*BlockRmSettings, error)
type DagPutOption ¶
type DagPutOption func(*DagPutSettings) error
type DagPutSettings ¶
type DagPutSettings struct {
InputEnc string
Codec uint64
MhType uint64
MhLength int
}
func DagPutOptions ¶
func DagPutOptions(opts ...DagPutOption) (*DagPutSettings, error)
type DagTreeOption ¶
type DagTreeOption func(*DagTreeSettings) error
type DagTreeSettings ¶
type DagTreeSettings struct {
Depth int
}
func DagTreeOptions ¶
func DagTreeOptions(opts ...DagTreeOption) (*DagTreeSettings, error)
type DhtFindProvidersOption ¶ added in v0.4.18
type DhtFindProvidersOption func(*DhtFindProvidersSettings) error
type DhtFindProvidersSettings ¶ added in v0.4.18
type DhtFindProvidersSettings struct {
NumProviders int
}
func DhtFindProvidersOptions ¶ added in v0.4.18
func DhtFindProvidersOptions(opts ...DhtFindProvidersOption) (*DhtFindProvidersSettings, error)
type DhtProvideOption ¶ added in v0.4.18
type DhtProvideOption func(*DhtProvideSettings) error
type DhtProvideSettings ¶ added in v0.4.18
type DhtProvideSettings struct {
Recursive bool
}
func DhtProvideOptions ¶ added in v0.4.18
func DhtProvideOptions(opts ...DhtProvideOption) (*DhtProvideSettings, error)
type KeyGenerateOption ¶
type KeyGenerateOption func(*KeyGenerateSettings) error
type KeyGenerateSettings ¶
type KeyGenerateSettings struct {
Algorithm string
Size int
}
func KeyGenerateOptions ¶
func KeyGenerateOptions(opts ...KeyGenerateOption) (*KeyGenerateSettings, error)
type KeyRenameOption ¶
type KeyRenameOption func(*KeyRenameSettings) error
type KeyRenameSettings ¶
type KeyRenameSettings struct {
Force bool
}
func KeyRenameOptions ¶
func KeyRenameOptions(opts ...KeyRenameOption) (*KeyRenameSettings, error)
type NamePublishOption ¶
type NamePublishOption func(*NamePublishSettings) error
type NamePublishSettings ¶
type NamePublishSettings struct {
ValidTime time.Duration
Key string
TTL *time.Duration
AllowOffline bool
}
func NamePublishOptions ¶
func NamePublishOptions(opts ...NamePublishOption) (*NamePublishSettings, error)
type NameResolveOption ¶
type NameResolveOption func(*NameResolveSettings) error
type NameResolveSettings ¶
type NameResolveSettings struct {
Local bool
Cache bool
ResolveOpts []ropts.ResolveOpt
}
func NameResolveOptions ¶
func NameResolveOptions(opts ...NameResolveOption) (*NameResolveSettings, error)
type ObjectAddLinkOption ¶
type ObjectAddLinkOption func(*ObjectAddLinkSettings) error
type ObjectAddLinkSettings ¶
type ObjectAddLinkSettings struct {
Create bool
}
func ObjectAddLinkOptions ¶
func ObjectAddLinkOptions(opts ...ObjectAddLinkOption) (*ObjectAddLinkSettings, error)
type ObjectNewOption ¶
type ObjectNewOption func(*ObjectNewSettings) error
type ObjectNewSettings ¶
type ObjectNewSettings struct {
Type string
}
func ObjectNewOptions ¶
func ObjectNewOptions(opts ...ObjectNewOption) (*ObjectNewSettings, error)
type ObjectPutOption ¶
type ObjectPutOption func(*ObjectPutSettings) error
type ObjectPutSettings ¶
type ObjectPutSettings struct {
InputEnc string
DataType string
Pin bool
}
func ObjectPutOptions ¶
func ObjectPutOptions(opts ...ObjectPutOption) (*ObjectPutSettings, error)
type PinAddOption ¶
type PinAddOption func(*PinAddSettings) error
type PinAddSettings ¶
type PinAddSettings struct {
Recursive bool
}
func PinAddOptions ¶
func PinAddOptions(opts ...PinAddOption) (*PinAddSettings, error)
type PinLsOption ¶
type PinLsOption func(settings *PinLsSettings) error
type PinLsSettings ¶
type PinLsSettings struct {
Type string
}
func PinLsOptions ¶
func PinLsOptions(opts ...PinLsOption) (*PinLsSettings, error)
type PinUpdateOption ¶
type PinUpdateOption func(*PinUpdateSettings) error
type PinUpdateSettings ¶
type PinUpdateSettings struct {
Unpin bool
}
func PinUpdateOptions ¶
func PinUpdateOptions(opts ...PinUpdateOption) (*PinUpdateSettings, error)
type PubSubPeersOption ¶ added in v0.4.18
type PubSubPeersOption func(*PubSubPeersSettings) error
type PubSubPeersSettings ¶ added in v0.4.18
type PubSubPeersSettings struct {
Topic string
}
func PubSubPeersOptions ¶ added in v0.4.18
func PubSubPeersOptions(opts ...PubSubPeersOption) (*PubSubPeersSettings, error)
type PubSubSubscribeOption ¶ added in v0.4.18
type PubSubSubscribeOption func(*PubSubSubscribeSettings) error
type PubSubSubscribeSettings ¶ added in v0.4.18
type PubSubSubscribeSettings struct {
Discover bool
}
func PubSubSubscribeOptions ¶ added in v0.4.18
func PubSubSubscribeOptions(opts ...PubSubSubscribeOption) (*PubSubSubscribeSettings, error)
type UnixfsAddOption ¶ added in v0.4.18
type UnixfsAddOption func(*UnixfsAddSettings) error
type UnixfsAddSettings ¶ added in v0.4.18
type UnixfsAddSettings struct {
CidVersion int
MhType uint64
Inline bool
InlineLimit int
RawLeaves bool
RawLeavesSet bool
Chunker string
Layout Layout
Pin bool
OnlyHash bool
Local bool
FsCache bool
NoCopy bool
Wrap bool
Hidden bool
StdinName string
Events chan<- interface{}
Silent bool
Progress bool
}
func UnixfsAddOptions ¶ added in v0.4.18
func UnixfsAddOptions(opts ...UnixfsAddOption) (*UnixfsAddSettings, cid.Prefix, error)
Click to show internal directories.
Click to hide internal directories.