Skip to main content

SpongeBuilder

Struct SpongeBuilder 

Source
#[non_exhaustive]
pub struct SpongeBuilder { /* private fields */ }
Expand description

Builder for Sponge. All chain methods are #[must_use].

Implementations§

Source§

impl SpongeBuilder

Source

pub fn new() -> Self

Construct a new builder defaulting to Target::Stdout, no-append, 128 MiB spill threshold, Default mode.

Source

pub fn target(self, target: Target) -> Self

Set the target.

Source

pub fn append(self, append: bool) -> Self

Enable -a append mode. Reads existing file contents into the buffer before stdin. Requires Target::File; otherwise build() returns Error::InvalidBuilderConfiguration.

Source

pub fn spill_threshold(self, bytes: usize) -> Self

Set the spill threshold in bytes.

Source

pub fn compat(self, compat: CompatibilityMode) -> Self

Set the compatibility mode.

Source

pub fn build(self) -> Result<Sponge, Error>

Validate the configuration and build a Sponge.

Trait Implementations§

Source§

impl Clone for SpongeBuilder

Source§

fn clone(&self) -> SpongeBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpongeBuilder

Source§

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

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

impl Default for SpongeBuilder

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<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, 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> 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.