Struct Mfs 

pub struct Mfs { /* private fields */ }

Handle to the node’s mutable filesystem. Obtain it via crate::Ipfs::mfs.

Implementations

impl Mfs

pub fn with_shard_threshold(self, threshold: Option<u64>) -> Self

pub async fn root(&self) -> Result<Option<Cid>, Error>

Returns the current MFS root Cid, or None if nothing has been written yet.

pub async fn mkdir(&self, path: &str, parents: bool) -> Result<(), Error>

Creates a directory at path. With parents, missing intermediate directories are created; otherwise a missing parent is an error.

pub async fn write( &self, path: &str, data: &[u8], parents: bool, ) -> Result<(), Error>

Writes data as the whole file at path, creating or replacing it.

pub async fn write_with( &self, path: &str, data: &[u8], opts: WriteOptions, ) -> Result<(), Error>

Writes data into the file at path starting at opts.offset, preserving the surrounding bytes (read-modify-rewrite). create makes a missing file, truncate discards existing content first, parents creates missing directories.

pub async fn truncate(&self, path: &str, size: u64) -> Result<(), Error>

Sets the file at path to exactly size bytes, truncating or zero-extending.

pub fn write_from_file( &self, path: &str, file: impl AsRef<Path>, parents: bool, ) -> MfsWrite

Write the whole content of file at path.

pub fn write_stream<S>(&self, path: &str, stream: S, parents: bool) -> MfsWrite

where S: Stream<Item = Result<Bytes>> + Send + 'static,

Writes the whole file at path from a byte stream without buffering the content, creating or replacing it.

pub async fn read(&self, path: &str) -> Result<Vec<u8>, Error>

Reads the whole content of the file at path.

pub async fn read_range( &self, path: &str, offset: u64, count: Option<u64>, ) -> Result<Vec<u8>, Error>

Reads count bytes (or to EOF if None) of the file at path, starting at offset.

pub fn read_stream( &self, path: &str, ) -> impl Stream<Item = Result<Bytes, Error>>

Streams the content of the file at path as it is read, without buffering the whole file.

pub fn read_stream_range( &self, path: &str, offset: u64, count: Option<u64>, ) -> impl Stream<Item = Result<Bytes, Error>>

Streams count bytes (or to EOF if None) of the file at path, starting at offset, reading only the blocks that overlap the range.

pub fn read_to_file(&self, path: &str, dest: impl AsRef<Path>) -> MfsRead

Reads the file at path and writes it to the local filesystem at dest, streaming through without buffering. The returned MfsRead is both a progress Stream and a future resolving to the number of bytes written.

pub async fn rm(&self, path: &str, recursive: bool) -> Result<(), Error>

Removes the entry at path. A non-empty directory requires recursive.

pub async fn rm_force(&self, path: &str, recursive: bool) -> Result<(), Error>

Removes the entry at path if present, succeeding when it is already absent.

pub async fn cp(&self, from: &str, to: &str, parents: bool) -> Result<(), Error>

Copies from to the MFS path to. from is either another MFS path or an /ipfs (or /ipld) path, in which case the referenced DAG is fetched locally and imported.

pub async fn mv(&self, from: &str, to: &str, parents: bool) -> Result<(), Error>

Moves the MFS entry at from to to. Non-atomic: it links the destination then unlinks the source as two commits, so a failure between them leaves the entry at both paths (never lost).

pub async fn ls(&self, path: &str) -> Result<Vec<MfsEntry>, Error>

Lists the immediate entries of the directory at path (/ for the root). A file path lists the single file itself, matching ipfs files ls.

pub async fn stat(&self, path: &str) -> Result<MfsStat, Error>

Returns type and size information for the entry at path.

pub async fn exists(&self, path: &str) -> Result<bool, Error>

Returns whether anything exists at path.

Trait Implementations

impl Clone for Mfs

fn clone(&self) -> Mfs

Returns a duplicate of the value.

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

Performs copy-assignment from source.