interface-go-ipfs-core: github.com/ipfs/interface-go-ipfs-core/options/namesys Index | Files

package nsopts

import "github.com/ipfs/interface-go-ipfs-core/options/namesys"

Index

Package Files

opts.go

Constants

const (
    // DefaultDepthLimit is the default depth limit used by Resolve.
    DefaultDepthLimit = 32

    // UnlimitedDepth allows infinite recursion in Resolve.  You
    // probably don't want to use this, but it's here if you absolutely
    // trust resolution to eventually complete and can't put an upper
    // limit on how many steps it will take.
    UnlimitedDepth = 0
)

type ResolveOpt Uses

type ResolveOpt func(*ResolveOpts)

ResolveOpt is used to set an option

func Depth Uses

func Depth(depth uint) ResolveOpt

Depth is the recursion depth limit

func DhtRecordCount Uses

func DhtRecordCount(count uint) ResolveOpt

DhtRecordCount is the number of IPNS records to retrieve from the DHT

func DhtTimeout Uses

func DhtTimeout(timeout time.Duration) ResolveOpt

DhtTimeout is the amount of time to wait for DHT records to be fetched and verified. A zero value indicates that there is no explicit timeout

type ResolveOpts Uses

type ResolveOpts struct {
    // Recursion depth limit
    Depth uint
    // The number of IPNS records to retrieve from the DHT
    // (the best record is selected from this set)
    DhtRecordCount uint
    // The amount of time to wait for DHT records to be fetched
    // and verified. A zero value indicates that there is no explicit
    // timeout (although there is an implicit timeout due to dial
    // timeouts within the DHT)
    DhtTimeout time.Duration
}

ResolveOpts specifies options for resolving an IPNS path

func DefaultResolveOpts Uses

func DefaultResolveOpts() ResolveOpts

DefaultResolveOpts returns the default options for resolving an IPNS path

func ProcessOpts Uses

func ProcessOpts(opts []ResolveOpt) ResolveOpts

ProcessOpts converts an array of ResolveOpt into a ResolveOpts object

Package nsopts imports 1 packages (graph) and is imported by 29 packages. Updated 2019-02-13. Refresh now. Tools for package owners.