Struct ipfs_embed::Ipfs

pub struct Ipfs<P, S, N> { /* fields omitted */ }

Implementations

impl<P, S, N> Ipfs<P, S, N> where
    P: StoreParams + Unpin + 'static,
    S: Storage<P>,
    N: Network<P>,
    Ipld: Decode<P::Codecs>, 

pub fn new(storage: Arc<S>, network: Arc<N>, timeout: Duration) -> Self

pub fn local_peer_id(&self) -> &PeerId

pub fn external_addresses(&self) -> Vec<Multiaddr>

Trait Implementations

impl<P, S, N> Clone for Ipfs<P, S, N>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P, S, N> Store for Ipfs<P, S, N> where
    P: StoreParams + Unpin + 'static,
    S: Storage<P>,
    N: Network<P>,
    Ipld: Decode<P::Codecs>, 

type Params = P

Store parameters.

fn get<'life0, 'life1, 'async_trait>(
    &'life0 self,
    cid: &'life1 Cid
) -> Pin<Box<dyn Future<Output = Result<Block<P>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Returns a block from the store. If the store supports networking and the block is not in the store it fetches it from the network. Dropping the future cancels the request. This will not insert the block into the store.

fn commit<'life0, 'async_trait>(
    &'life0 self,
    tx: Transaction<P>
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Commits a transaction to the store.

#[must_use]fn insert<'life0, 'async_trait>(
    &'life0 self,
    block: Block<Self::Params>
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    Self: 'async_trait,
    Ipld: Decode<<Self::Params as StoreParams>::Codecs>, 

Inserts a block into the store.

#[must_use]fn unpin<'life0, 'life1, 'async_trait>(
    &'life0 self,
    cid: &'life1 Cid
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Unpins a block from the store.

#[must_use]fn query<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    path: &'life1 DagPath<'life2>
) -> Pin<Box<dyn Future<Output = Result<Ipld, Error>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait,
    Ipld: Decode<<Self::Params as StoreParams>::Codecs>, 

Resolves a path recursively and returns the ipld.

#[must_use]fn sync<'life0, 'async_trait>(
    &'life0 self,
    old: Option<Cid>,
    new: Cid
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    Self: 'async_trait,
    Ipld: Decode<<Self::Params as StoreParams>::Codecs>, 

Recursively gets a block and all it's references, inserts them into the store, pins the root and unpins the old root.

#[must_use]fn flush<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Flushes the write buffer.