options

package
v0.11.2 Latest Latest
Warning

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

 Go to latest Published: May 25, 2023 License: MIT Imports: 8 Imported by: 167

Documentation

Index

Constants

View Source 
const (
	// Deprecated: use github.com/ipfs/boxo/coreiface/options.RSAKey
	RSAKey = "rsa"
	// Deprecated: use github.com/ipfs/boxo/coreiface/options.Ed25519Key
	Ed25519Key = "ed25519"

	// Deprecated: use github.com/ipfs/boxo/coreiface/options.DefaultRSALen
	DefaultRSALen = 2048
)
View Source 
const (
	// Deprecated: use github.com/ipfs/boxo/coreiface/options.DefaultNameValidTime
	DefaultNameValidTime = 24 * time.Hour
)

Variables

View Source 
var Api apiOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Api

View Source 
var Block blockOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Block

View Source 
var Dht dhtOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Dht

View Source 
var Key keyOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Key

View Source 
var Name nameOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Name

View Source 
var Object objectOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Object

View Source 
var Pin pinOpts

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.Pin

View Source 
var PubSub pubsubOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSub

View Source 
var Unixfs unixfsOpts

Deprecated: use github.com/ipfs/boxo/coreiface/options.Unixfs

Functions

This section is empty.

Types

type ApiOption deprecated 

type ApiOption func(*ApiSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiOption

type ApiSettings deprecated 

type ApiSettings struct {
	Offline     bool
	FetchBlocks bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiSettings

func ApiOptions deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiOptions

func ApiOptionsTo deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiOptionsTo

type BlockPutOption deprecated 

type BlockPutOption func(*BlockPutSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockPutOption

type BlockPutSettings deprecated 

type BlockPutSettings struct {
	CidPrefix cid.Prefix
	Pin       bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockPutSettings

func BlockPutOptions deprecated 

func BlockPutOptions(opts ...BlockPutOption) (*BlockPutSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockPutOptions

type BlockRmOption deprecated 

type BlockRmOption func(*BlockRmSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockRmOption

type BlockRmSettings deprecated 

type BlockRmSettings struct {
	Force bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockRmSettings

func BlockRmOptions deprecated 

func BlockRmOptions(opts ...BlockRmOption) (*BlockRmSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockRmOptions

type DhtFindProvidersOption deprecated 

type DhtFindProvidersOption func(*DhtFindProvidersSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtFindProvidersOption

type DhtFindProvidersSettings deprecated 

type DhtFindProvidersSettings struct {
	NumProviders int
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtFindProvidersSettings

func DhtFindProvidersOptions deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtFindProvidersOptions

type DhtProvideOption deprecated 

type DhtProvideOption func(*DhtProvideSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtProvideOption

type DhtProvideSettings deprecated 

type DhtProvideSettings struct {
	Recursive bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtProvideSettings

func DhtProvideOptions deprecated 

func DhtProvideOptions(opts ...DhtProvideOption) (*DhtProvideSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtProvideOptions

type KeyGenerateOption deprecated 

type KeyGenerateOption func(*KeyGenerateSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyGenerateOption

type KeyGenerateSettings deprecated 

type KeyGenerateSettings struct {
	Algorithm string
	Size      int
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyGenerateSettings

func KeyGenerateOptions deprecated 

func KeyGenerateOptions(opts ...KeyGenerateOption) (*KeyGenerateSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyGenerateOptions

type KeyRenameOption deprecated 

type KeyRenameOption func(*KeyRenameSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyRenameOption

type KeyRenameSettings deprecated 

type KeyRenameSettings struct {
	Force bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyRenameSettings

func KeyRenameOptions deprecated 

func KeyRenameOptions(opts ...KeyRenameOption) (*KeyRenameSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyRenameOptions

type Layout deprecated 

type Layout int

Deprecated: use github.com/ipfs/boxo/coreiface/options.Layout 

const (
	// Deprecated: use github.com/ipfs/boxo/coreiface/options.BalancedLayout
	BalancedLayout Layout = iota
	// Deprecated: use github.com/ipfs/boxo/coreiface/options.TrickleLayout
	TrickleLayout
)

type NamePublishOption deprecated 

type NamePublishOption func(*NamePublishSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.NamePublishOption

type NamePublishSettings deprecated 

type NamePublishSettings struct {
	ValidTime time.Duration
	Key       string

	TTL *time.Duration

	AllowOffline bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.NamePublishSettings

func NamePublishOptions deprecated 

func NamePublishOptions(opts ...NamePublishOption) (*NamePublishSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.NamePublishOptions

type NameResolveOption deprecated 

type NameResolveOption func(*NameResolveSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.NameResolveOption

type NameResolveSettings deprecated 

type NameResolveSettings struct {
	Cache bool

	ResolveOpts []ropts.ResolveOpt
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.NameResolveSettings

func NameResolveOptions deprecated 

func NameResolveOptions(opts ...NameResolveOption) (*NameResolveSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.NameResolveOptions

type ObjectAddLinkOption deprecated 

type ObjectAddLinkOption func(*ObjectAddLinkSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectAddLinkOption

type ObjectAddLinkSettings deprecated 

type ObjectAddLinkSettings struct {
	Create bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectAddLinkSettings

func ObjectAddLinkOptions deprecated 

func ObjectAddLinkOptions(opts ...ObjectAddLinkOption) (*ObjectAddLinkSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectAddLinkOptions

type ObjectNewOption deprecated 

type ObjectNewOption func(*ObjectNewSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectNewOption

type ObjectNewSettings deprecated 

type ObjectNewSettings struct {
	Type string
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectNewSettings

func ObjectNewOptions deprecated 

func ObjectNewOptions(opts ...ObjectNewOption) (*ObjectNewSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectNewOptions

type ObjectPutOption deprecated 

type ObjectPutOption func(*ObjectPutSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectPutOption

type ObjectPutSettings deprecated 

type ObjectPutSettings struct {
	InputEnc string
	DataType string
	Pin      bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectPutSettings

func ObjectPutOptions deprecated 

func ObjectPutOptions(opts ...ObjectPutOption) (*ObjectPutSettings, error)

Deprecated: use github.com/ipfs/boxo/coreiface/options.ObjectPutOptions

type PinAddOption deprecated 

type PinAddOption func(*PinAddSettings) error

PinAddOption is the signature of an option for PinAPI.Add

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinAddOption

type PinAddSettings deprecated 

type PinAddSettings struct {
	Recursive bool
}

PinAddSettings represent the settings for PinAPI.Add

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinAddSettings

func PinAddOptions deprecated 

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

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinAddOptions

type PinIsPinnedOption deprecated added in v0.3.0 

type PinIsPinnedOption func(*PinIsPinnedSettings) error

PinIsPinnedOption is the signature of an option for PinAPI.IsPinned

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinIsPinnedOption

type PinIsPinnedSettings deprecated added in v0.3.0 

type PinIsPinnedSettings struct {
	WithType string
}

PinIsPinnedSettings represent the settings for PinAPI.IsPinned

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinIsPinnedSettings

func PinIsPinnedOptions deprecated 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.

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinIsPinnedOptions

type PinLsOption deprecated 

type PinLsOption func(*PinLsSettings) error

PinLsOption is the signature of an option for PinAPI.Ls

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinLsOption

type PinLsSettings deprecated 

type PinLsSettings struct {
	Type string
}

PinLsSettings represent the settings for PinAPI.Ls

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinLsSettings

func PinLsOptions deprecated 

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

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinLsOptions

type PinRmOption deprecated 

type PinRmOption func(*PinRmSettings) error

PinRmOption is the signature of an option for PinAPI.Rm

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinRmOption

type PinRmSettings deprecated 

type PinRmSettings struct {
	Recursive bool
}

PinRmSettings represents the settings for PinAPI.Rm

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinRmSettings

func PinRmOptions deprecated 

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

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinRmOptions

type PinUpdateOption deprecated 

type PinUpdateOption func(*PinUpdateSettings) error

PinUpdateOption is the signature of an option for PinAPI.Update

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinUpdateOption

type PinUpdateSettings deprecated 

type PinUpdateSettings struct {
	Unpin bool
}

PinUpdateSettings represent the settings for PinAPI.Update

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinUpdateSettings

func PinUpdateOptions deprecated 

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

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.PinUpdateOptions

type PubSubPeersOption deprecated 

type PubSubPeersOption func(*PubSubPeersSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSubPeersOption

type PubSubPeersSettings deprecated 

type PubSubPeersSettings struct {
	Topic string
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSubPeersSettings

func PubSubPeersOptions deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSubPeersOptions

type PubSubSubscribeOption deprecated 

type PubSubSubscribeOption func(*PubSubSubscribeSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSubSubscribeOption

type PubSubSubscribeSettings deprecated 

type PubSubSubscribeSettings struct {
	Discover bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSubSubscribeSettings

func PubSubSubscribeOptions deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.PubSubSubscribeOptions

type UnixfsAddOption deprecated 

type UnixfsAddOption func(*UnixfsAddSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.UnixfsAddOption

type UnixfsAddSettings deprecated 

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
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.UnixfsAddSettings

func UnixfsAddOptions deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.UnixfsAddOptions

type UnixfsLsOption deprecated 

type UnixfsLsOption func(*UnixfsLsSettings) error

Deprecated: use github.com/ipfs/boxo/coreiface/options.UnixfsLsOption

type UnixfsLsSettings deprecated 

type UnixfsLsSettings struct {
	ResolveChildren   bool
	UseCumulativeSize bool
}

Deprecated: use github.com/ipfs/boxo/coreiface/options.UnixfsLsSettings

func UnixfsLsOptions deprecated 

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

Deprecated: use github.com/ipfs/boxo/coreiface/options.UnixfsLsOptions

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.