Struct BaseApi

pub struct BaseApi { /* private fields */ }

The default implemented API for interfacing with the IPFS RPC API. This functionality is achieved by implementing the PeerApi trait for BaseApi.

To change or enhance any of the functionality of interfacing with the IPFS RPC API, users of ipfs-webdav need to implement the PeerApi trait for their implementation of an API that interfaces with the IPFS PRC API.

Implementations

impl BaseApi

pub fn new() -> Box<BaseApi>

Creates default instance of BaseApi

pub fn from_uri(uri: &str) -> Box<BaseApi>

Creates a new instance of BaseApi from a provided IPFS API Server URI

pub fn from_ipfs_client(ipfs: IpfsClient) -> Box<BaseApi>

Creates a new instance of BaseApi from provided IpfsClient

Trait Implementations

impl Debug for BaseApi

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

Formats the value using the given formatter.

impl PeerApi for BaseApi

fn cp<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 str, dest: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Add references to IPFS files and directories in MFS (or copy within MFS).

fn flush<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Flush a given path’s data to disk.

fn ls<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<PeerEntry>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List directories in the local mutable namespace.

fn mkdir<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<PeerEntry, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Make directories.

fn mv<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 str, dest: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move files.

fn read<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, offset: usize, count: usize, ) -> Pin<Box<dyn Future<Output = Result<Bytes, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read a file in a given MFS.

fn rm<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a file.

fn stat<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<PeerEntry, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Display file status.

fn write<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, offset: usize, truncate: bool, data: Bytes, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Write to a mutable file in a given filesystem.