Struct rust_ipfs::IpfsOptions

pub struct IpfsOptions {

    pub ipfs_path: StorageType,
    pub bootstrap: Vec<Multiaddr>,
    pub relay_server_config: RelayConfig,
    pub listening_addrs: Vec<Multiaddr>,
    pub transport_configuration: TransportConfig,
    pub swarm_configuration: SwarmConfig,
    pub identify_configuration: IdentifyConfiguration,
    pub pubsub_config: PubsubConfig,
    pub kad_configuration: Either<KadConfig, Config>,
    pub kad_store_config: KadStoreConfig,
    pub ping_configuration: Config,
    pub addr_config: AddressBookConfig,
    pub keystore: Keystore,
    pub connection_idle: Duration,
    pub provider: RepoProvider,
    pub span: Option<Span>,
    /* private fields */
}

Ipfs node options used to configure the node to be created with UninitializedIpfs.

Fields

ipfs_path: StorageType

The path of the ipfs repo (blockstore and datastore).

This is always required but can be any path with in-memory backends. The filesystem backend creates a directory structure alike but not compatible to other ipfs implementations.

Incompatiblity and interop warning

It is not recommended to set this to IPFS_PATH without first at least backing up your existing repository.

bootstrap: Vec<Multiaddr>

Nodes used as bootstrap peers.

relay_server_config: RelayConfig

Relay server config

listening_addrs: Vec<Multiaddr>

Bound listening addresses; by default the node will not listen on any address.

transport_configuration: TransportConfig

Transport configuration

swarm_configuration: SwarmConfig

Swarm configuration

identify_configuration: IdentifyConfiguration

Identify configuration

pubsub_config: PubsubConfig

Pubsub configuration

kad_configuration: Either<KadConfig, Config>

Kad configuration

kad_store_config: KadStoreConfig

Kad Store Config Note: Only supports MemoryStoreConfig at this time

ping_configuration: Config

Ping Configuration

addr_config: AddressBookConfig

Address book configuration

keystore: Keystore

connection_idle: Duration

Connection idle

provider: RepoProvider

Repo Provider option

span: Option<Span>

The span for tracing purposes, None value is converted to tracing::trace_span!("ipfs").

All futures returned by Ipfs, background task actions and swarm actions are instrumented with this span or spans referring to this as their parent. Setting this other than None default is useful when running multiple nodes.

Trait Implementations

impl Debug for IpfsOptions

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IpfsOptions

fn default() -> Self

Returns the “default value” for a type.