Struct rust_ipfs::IpfsOptions

pub struct IpfsOptions {

    pub ipfs_path: PathBuf,
    pub keypair: Keypair,
    pub bootstrap: Vec<Multiaddr>,
    pub mdns: bool,
    pub mdns_ipv6: bool,
    pub keep_alive: bool,
    pub dcutr: bool,
    pub relay: bool,
    pub relay_server: bool,
    pub relay_server_config: Option<RelayConfig>,
    pub listening_addrs: Vec<Multiaddr>,
    pub transport_configuration: Option<TransportConfig>,
    pub swarm_configuration: Option<SwarmConfig>,
    pub identify_configuration: Option<IdentifyConfiguration>,
    pub kad_configuration: Option<KademliaConfig>,
    pub kad_store_config: Option<KadStoreConfig>,
    pub ping_configuration: Option<PingConfig>,
    pub port_mapping: bool,
    pub span: Option<Span>,
}

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

Fields

ipfs_path: PathBuf

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.

keypair: Keypair

The keypair used with libp2p, the identity of the node.

bootstrap: Vec<Multiaddr>

Nodes used as bootstrap peers.

mdns: bool

Enables mdns for peer discovery and announcement when true.

mdns_ipv6: bool

Enables ipv6 for mdns

keep_alive: bool

Keep connection alive

dcutr: bool

Enables dcutr

relay: bool

Enables relay client.

relay_server: bool

Enables relay server

relay_server_config: Option<RelayConfig>

Relay server config

listening_addrs: Vec<Multiaddr>

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

transport_configuration: Option<TransportConfig>

Transport configuration

swarm_configuration: Option<SwarmConfig>

Swarm configuration

identify_configuration: Option<IdentifyConfiguration>

Identify configuration

kad_configuration: Option<KademliaConfig>

Kad configuration

kad_store_config: Option<KadStoreConfig>

Kad Store Config Note: Only supports MemoryStoreConfig at this time

ping_configuration: Option<PingConfig>

Ping Configuration

port_mapping: bool

Enables port mapping (aka UPnP)

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.

Implementations

impl IpfsOptions

pub fn inmemory_with_generated_keys() -> Self

Creates an in-memory store backed configuration useful for any testing purposes.

Also used from examples.

Trait Implementations

impl Clone for IpfsOptions

fn clone(&self) -> IpfsOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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.

impl From<&IpfsOptions> for RepoOptions

fn from(options: &IpfsOptions) -> Self

Converts to this type from the input type.

impl From<&IpfsOptions> for SwarmOptions

fn from(options: &IpfsOptions) -> Self

Converts to this type from the input type.