Skip to main content

MfsWriteOptions

Struct MfsWriteOptions 

Source
pub struct MfsWriteOptions {
    pub create: bool,
    pub parents: bool,
    pub truncate: bool,
    pub count: Option<u64>,
    pub offset: u64,
    pub raw_leaves: bool,
    pub cid_version: u8,
    pub hash: String,
}
Expand description

Options for an MFS file write operation.

Controls how data is written to a file in MFS, including whether to create the file, where to write, and how to encode the content.

§Kubo Equivalent

Corresponds to the flags of ipfs files write command. See core/commands/files.go:filesWriteCmd.

§Example

use ferripfs_network::MfsWriteOptions;

// Create a file if it doesn't exist
let mut opts = MfsWriteOptions::default();
opts.create = true;
opts.parents = true;

assert!(opts.create);
assert!(opts.parents);

Fields§

§create: bool

Create the file if it doesn’t exist.

Without this, writing to a non-existent file will fail.

§parents: bool

Create parent directories as needed.

Similar to mkdir -p behavior.

§truncate: bool

Truncate the file before writing.

When true, the file is cleared before new data is written.

§count: Option<u64>

Maximum number of bytes to write from input.

If None, all input data is written.

§offset: u64

Byte offset within the file to start writing at.

Allows appending or overwriting at a specific position.

§raw_leaves: bool

Use raw leaves in the UnixFS DAG.

When true, leaf nodes contain raw data without UnixFS wrapping.

§cid_version: u8

CID version to use for new blocks (0 or 1).

§hash: String

Hash algorithm for content addressing.

Default is “sha2-256”.

Implementations§

Source§

impl MfsWriteOptions

Source

pub fn create_new() -> Self

Create options for creating a new file

Source

pub fn append() -> Self

Create options for appending to a file

Trait Implementations§

Source§

impl Clone for MfsWriteOptions

Source§

fn clone(&self) -> MfsWriteOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MfsWriteOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MfsWriteOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more