Struct rust_ipfs::UninitializedIpfs

pub struct UninitializedIpfs<Types: IpfsTypes> { /* private fields */ }

Configured Ipfs which can only be started.

Implementations

impl<Types: IpfsTypes> UninitializedIpfs<Types>

pub fn new(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 fd_limit(self, limit: FDLimit) -> Self

Set file desc limit

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 spawn_start(self) -> Result<Ipfs<Types>, Error>

Same as crate::UninitializedIpfs::start except we use tokio::spawn internally

pub async fn start(
    self
) -> Result<(Ipfs<Types>, impl Future<Output = ()>), Error>

Initialize the ipfs node. The returned Ipfs value is cloneable, send and sync, and the future should be spawned on a executor as soon as possible.

The future returned from this method should not need (instrumenting)tracing_futures::Instrument::instrument as the IpfsOptions::span will be used as parent span for all of the awaited and created futures.