Struct mfs::Mfs

pub struct Mfs {
    pub hash_default: String,
    pub cid_default: i32,
    pub raw_leaves_default: bool,
    // some fields omitted
}

The main struct

All of its functions will panic if the passed paths are not valid unicode.

Fields

hash_default: String

Default hash function to use for write / create operations.

cid_default: i32

Default cid version to request on write / create operations. Defaults to 1.

raw_leaves_default: bool

Whether to write files with raw-leaves

Implementations

impl Mfs

pub fn new(api: &str) -> Result<Mfs, InvalidUri>

pub async fn rm_r<P: AsRef<Path>, '_>(&'_ self, p: P) -> Result<(), MfsError>

Remove file or folder (possibly non-empty)

pub async fn rm<P: AsRef<Path>, '_>(&'_ self, p: P) -> Result<(), MfsError>

Remove file

pub async fn mkdirs<P: AsRef<Path>, '_>(&'_ self, p: P) -> Result<(), MfsError>

Create directory p and parents as needed.

pub async fn mkdir<P: AsRef<Path>, '_>(&'_ self, p: P) -> Result<(), MfsError>

Create directory p. Requires that its parent already exist.

pub async fn mv<PS: AsRef<Path>, PD: AsRef<Path>, '_>(
    &'_ self,
    s: PS,
    d: PD
) -> Result<(), MfsError>

Rename / move s to d.

pub async fn cp<PS: AsRef<Path>, PD: AsRef<Path>, '_>(
    &'_ self,
    s: PS,
    d: PD
) -> Result<(), MfsError>

Copy path s to path d. Beware of s starting with /ipfs or /ipns.

pub async fn ls<P: AsRef<Path>, '_>(
    &'_ self,
    p: P
) -> Result<Vec<PathBuf>, MfsError>

List files in folder

pub fn get<'a, P: AsRef<Path>>(
    &self,
    s: P
) -> impl Stream<Item = Result<Bytes, MfsError>>

Read file at s.

pub async fn get_fully<P: AsRef<Path>, '_>(
    &'_ self,
    s: P
) -> Result<Vec<u8>, MfsError>

Read file at s into in-memory buffer.

pub async fn flush<P: AsRef<Path>, '_>(&'_ self, p: P) -> Result<(), MfsError>

Flush folder

pub async fn put<P: AsRef<Path>, R: 'static + AsyncRead + Send + Sync + Unpin, '_>(
    &'_ self,
    d: P,
    __arg2: R
) -> Result<(), MfsError>

Write file to d.

Internally buffers chunks of 8 MiB and writes them with separate calls to IPFS due to limitations of multipart.

pub async fn stat<P: AsRef<Path>, '_>(
    &'_ self,
    p: P
) -> Result<Option<FilesStatResponse>, MfsError>

Request hash, type, sizes, and block count of p. Returns None if the file does not exist

Trait Implementations

impl Clone for Mfs

fn clone(&self) -> Mfs

Returns a copy of the value.

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

Performs copy-assignment from source.