Struct rust_ipfs::UninitializedIpfs

pub struct UninitializedIpfs { /* private fields */ }

Configured Ipfs which can only be started.

Implementations

impl UninitializedIpfs

pub fn new() -> Self

pub fn with_opt(options: IpfsOptions) -> Self

Configures a new UninitializedIpfs with from the given options and optionally a span. If the span is not given, it is defaulted to tracing::trace_span!("ipfs").

The span is attached to all operations called on the later created Ipfs along with all operations done in the background task as well as tasks spawned by the underlying libp2p::Swarm.

pub fn add_listening_addr(self, addr: Multiaddr) -> Self

Adds a listening address

pub fn add_bootstrap(self, addr: Multiaddr) -> Self

Adds a bootstrap node

pub fn set_path<P: AsRef<Path>>(self, path: P) -> Self

Sets a path

pub fn set_identify_configuration(self, config: IdentifyConfiguration) -> Self

Set identify configuration

pub fn set_transport_configuration(self, config: TransportConfig) -> Self

Set transport configuration

pub fn set_swarm_configuration(self, config: SwarmConfig) -> Self

Set swarm configuration

pub fn set_kad_configuration( self, config: KadConfig, store: Option<KadStoreConfig> ) -> Self

Set kad configuration

pub fn set_ping_configuration(self, config: PingConfig) -> Self

Set ping configuration

pub fn set_keypair(self, keypair: Keypair) -> Self

Set keypair

pub fn enable_keepalive(self) -> Self

Enable keep alive

pub fn enable_mdns(self) -> Self

Enable mdns

pub fn enable_relay(self, with_dcutr: bool) -> Self

Enable relay client

pub fn enable_relay_server(self, config: Option<RelayConfig>) -> Self

Enable relay server

pub fn enable_upnp(self) -> Self

Enable port mapping (AKA UPnP)

pub fn fd_limit(self, limit: FDLimit) -> Self

Set file desc limit

pub fn disable_delay(self) -> Self

Used to delay the loop Note: This may be removed in future

pub fn swarm_events<F>(self, func: F) -> Selfwhere F: Fn(&mut TSwarm, &<TSwarm as Stream>::Item) + Sync + Send + 'static,

Handle libp2p swarm events

pub async fn start(self) -> Result<Ipfs, Error>

Initialize the ipfs node. The returned Ipfs value is cloneable, send and sync.

Trait Implementations

impl Default for UninitializedIpfs

fn default() -> Self

Returns the “default value” for a type.