Version: v0.11.1 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Feb 10, 2023 License: MIT Imports: 8 Imported by: 181




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

	DefaultRSALen = 2048
View Source
const (
	DefaultNameValidTime = 24 * time.Hour


View Source
var Api apiOpts
View Source
var Block blockOpts
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

Pin provide an access to all the options for the Pin API.

View Source
var PubSub pubsubOpts
View Source
var Unixfs unixfsOpts


This section is empty.


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 {
	CidPrefix cid.Prefix
	Pin       bool

func BlockPutOptions

func BlockPutOptions(opts ...BlockPutOption) (*BlockPutSettings, 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

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

PinAddOption is the signature of an option for PinAPI.Add

type PinAddSettings

type PinAddSettings struct {
	Recursive bool

PinAddSettings represent the settings for PinAPI.Add

func PinAddOptions

func PinAddOptions(opts ...PinAddOption) (*PinAddSettings, error)

PinAddOptions compile a series of PinAddOption into a ready to use PinAddSettings and set the default values.

type PinIsPinnedOption added in v0.3.0

type PinIsPinnedOption func(*PinIsPinnedSettings) error

PinIsPinnedOption is the signature of an option for PinAPI.IsPinned

type PinIsPinnedSettings added in v0.3.0

type PinIsPinnedSettings struct {
	WithType string

PinIsPinnedSettings represent the settings for PinAPI.IsPinned

func PinIsPinnedOptions added in v0.3.0

func PinIsPinnedOptions(opts ...PinIsPinnedOption) (*PinIsPinnedSettings, error)

PinIsPinnedOptions compile a series of PinIsPinnedOption into a ready to use PinIsPinnedSettings and set the default values.

type PinLsOption

type PinLsOption func(*PinLsSettings) error

PinLsOption is the signature of an option for PinAPI.Ls

type PinLsSettings

type PinLsSettings struct {
	Type string

PinLsSettings represent the settings for PinAPI.Ls

func PinLsOptions

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

PinLsOptions compile a series of PinLsOption into a ready to use PinLsSettings and set the default values.

type PinRmOption

type PinRmOption func(*PinRmSettings) error

PinRmOption is the signature of an option for PinAPI.Rm

type PinRmSettings

type PinRmSettings struct {
	Recursive bool

PinRmSettings represents the settings for PinAPI.Rm

func PinRmOptions

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

PinRmOptions compile a series of PinRmOption into a ready to use PinRmSettings and set the default values.

type PinUpdateOption

type PinUpdateOption func(*PinUpdateSettings) error

PinUpdateOption is the signature of an option for PinAPI.Update

type PinUpdateSettings

type PinUpdateSettings struct {
	Unpin bool

PinUpdateSettings represent the settings for PinAPI.Update

func PinUpdateOptions

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

PinUpdateOptions compile a series of PinUpdateOption into a ready to use PinUpdateSettings and set the default values.

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

	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
	UseCumulativeSize bool

func UnixfsLsOptions

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


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL