options

Documentation

Index

• Constants
• Variables
• type ApiOption
• type ApiSettings
  • func ApiOptions(opts ...ApiOption) (*ApiSettings, error)
  • func ApiOptionsTo(options *ApiSettings, opts ...ApiOption) (*ApiSettings, error)
• type BlockPutOption
• type BlockPutSettings
  • func BlockPutOptions(opts ...BlockPutOption) (*BlockPutSettings, cid.Prefix, error)
• type BlockRmOption
• type BlockRmSettings
  • func BlockRmOptions(opts ...BlockRmOption) (*BlockRmSettings, error)
• type DhtFindProvidersOption
• type DhtFindProvidersSettings
  • func DhtFindProvidersOptions(opts ...DhtFindProvidersOption) (*DhtFindProvidersSettings, error)
• type DhtProvideOption
• type DhtProvideSettings
  • func DhtProvideOptions(opts ...DhtProvideOption) (*DhtProvideSettings, error)
• type KeyGenerateOption
• type KeyGenerateSettings
  • func KeyGenerateOptions(opts ...KeyGenerateOption) (*KeyGenerateSettings, error)
• type KeyRenameOption
• type KeyRenameSettings
  • func KeyRenameOptions(opts ...KeyRenameOption) (*KeyRenameSettings, error)
• type Layout
• type NamePublishOption
• type NamePublishSettings
  • func NamePublishOptions(opts ...NamePublishOption) (*NamePublishSettings, error)
• type NameResolveOption
• type NameResolveSettings
  • func NameResolveOptions(opts ...NameResolveOption) (*NameResolveSettings, error)
• type ObjectAddLinkOption
• type ObjectAddLinkSettings
  • func ObjectAddLinkOptions(opts ...ObjectAddLinkOption) (*ObjectAddLinkSettings, error)
• type ObjectNewOption
• type ObjectNewSettings
  • func ObjectNewOptions(opts ...ObjectNewOption) (*ObjectNewSettings, error)
• type ObjectPutOption
• type ObjectPutSettings
  • func ObjectPutOptions(opts ...ObjectPutOption) (*ObjectPutSettings, error)
• type PinAddOption
• type PinAddSettings
  • func PinAddOptions(opts ...PinAddOption) (*PinAddSettings, error)
• type PinLsOption
• type PinLsSettings
  • func PinLsOptions(opts ...PinLsOption) (*PinLsSettings, error)
• type PinRmOption
• type PinRmSettings
  • func PinRmOptions(opts ...PinRmOption) (*PinRmSettings, error)
• type PinUpdateOption
• type PinUpdateSettings
  • func PinUpdateOptions(opts ...PinUpdateOption) (*PinUpdateSettings, error)
• type PubSubPeersOption
• type PubSubPeersSettings
  • func PubSubPeersOptions(opts ...PubSubPeersOption) (*PubSubPeersSettings, error)
• type PubSubSubscribeOption
• type PubSubSubscribeSettings
  • func PubSubSubscribeOptions(opts ...PubSubSubscribeOption) (*PubSubSubscribeSettings, error)
• type UnixfsAddOption
• type UnixfsAddSettings
  • func UnixfsAddOptions(opts ...UnixfsAddOption) (*UnixfsAddSettings, cid.Prefix, error)
• type UnixfsLsOption
• type UnixfsLsSettings
  • func UnixfsLsOptions(opts ...UnixfsLsOption) (*UnixfsLsSettings, error)

Constants

const (
	RSAKey     = "rsa"
	Ed25519Key = "ed25519"

	DefaultRSALen = 2048
)

const (
	DefaultNameValidTime = 24 * time.Hour
)

Variables

var Api apiOpts

var Block blockOpts

var Dht dhtOpts

var Key keyOpts

var Name nameOpts

var Object objectOpts

var Pin pinOpts

var PubSub pubsubOpts

var Unixfs unixfsOpts

Types

type ApiOption

type ApiOption func(*ApiSettings) error

type ApiSettings

type ApiSettings struct {
	Offline     bool
	FetchBlocks bool
}

func ApiOptions

func ApiOptions(opts ...ApiOption) (*ApiSettings, error)

func ApiOptionsTo

func ApiOptionsTo(options *ApiSettings, opts ...ApiOption) (*ApiSettings, error)

type BlockPutOption

type BlockPutOption func(*BlockPutSettings) error

type BlockPutSettings

type BlockPutSettings struct {
	Codec    string
	MhType   uint64
	MhLength int
	Pin      bool
}

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 DhtFindProvidersOption

type DhtFindProvidersOption func(*DhtFindProvidersSettings) error

type DhtFindProvidersSettings

type DhtFindProvidersSettings struct {
	NumProviders int
}

func DhtFindProvidersOptions

func DhtFindProvidersOptions(opts ...DhtFindProvidersOption) (*DhtFindProvidersSettings, error)

type DhtProvideOption

type DhtProvideOption func(*DhtProvideSettings) error

type DhtProvideSettings

type DhtProvideSettings struct {
	Recursive bool
}

func DhtProvideOptions

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 Layout

type Layout int

const (
	BalancedLayout Layout = iota
	TrickleLayout
)

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 {
	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(*PinLsSettings) error

PinLsOption pin ls option func

type PinLsSettings

type PinLsSettings struct {
	Type string
}

func PinLsOptions

func PinLsOptions(opts ...PinLsOption) (*PinLsSettings, error)

type PinRmOption

type PinRmOption func(*PinRmSettings) error

PinRmOption pin rm option func

type PinRmSettings

type PinRmSettings struct {
	Recursive bool
}

PinRmSettings represents the settings of pin rm command

func PinRmOptions

func PinRmOptions(opts ...PinRmOption) (*PinRmSettings, error)

PinRmOptions pin rm options

type PinUpdateOption

type PinUpdateOption func(*PinUpdateSettings) error

type PinUpdateSettings

type PinUpdateSettings struct {
	Unpin bool
}

func PinUpdateOptions

func PinUpdateOptions(opts ...PinUpdateOption) (*PinUpdateSettings, error)

type PubSubPeersOption

type PubSubPeersOption func(*PubSubPeersSettings) error

type PubSubPeersSettings

type PubSubPeersSettings struct {
	Topic string
}

func PubSubPeersOptions

func PubSubPeersOptions(opts ...PubSubPeersOption) (*PubSubPeersSettings, error)

type PubSubSubscribeOption

type PubSubSubscribeOption func(*PubSubSubscribeSettings) error

type PubSubSubscribeSettings

type PubSubSubscribeSettings struct {
	Discover bool
}

func PubSubSubscribeOptions

func PubSubSubscribeOptions(opts ...PubSubSubscribeOption) (*PubSubSubscribeSettings, error)

type UnixfsAddOption

type UnixfsAddOption func(*UnixfsAddSettings) error

type UnixfsAddSettings

type UnixfsAddSettings struct {
	CidVersion int
	MhType     uint64

	Inline       bool
	InlineLimit  int
	RawLeaves    bool
	RawLeavesSet bool

	Chunker string
	Layout  Layout

	Pin      bool
	OnlyHash bool
	FsCache  bool
	NoCopy   bool

	Wrap      bool
	Hidden    bool
	StdinName string

	Events   chan<- interface{}
	Silent   bool
	Progress bool
}

func UnixfsAddOptions

func UnixfsAddOptions(opts ...UnixfsAddOption) (*UnixfsAddSettings, cid.Prefix, error)

type UnixfsLsOption

type UnixfsLsOption func(*UnixfsLsSettings) error

type UnixfsLsSettings

type UnixfsLsSettings struct {
	ResolveChildren bool
}

func UnixfsLsOptions

func UnixfsLsOptions(opts ...UnixfsLsOption) (*UnixfsLsSettings, error)