Struct CfBuildBuilder

Source

pub struct CfBuildBuilder<S: State = Empty> { /* private fields */ }

Expand description

Use builder syntax to set the inputs and finish with call().

Implementations§

Source §

impl<S: State> CfBuildBuilder<S>

Source

pub fn call(self) -> Result<CfBuildResult>
where S: IsComplete,

Finishes building and performs the requested action.

Source

pub fn input(self, value: CfInput) -> CfBuildBuilder<SetInput<S>>
where S::Input: IsUnset,

Required.

Source

pub fn output_prefix(self, value: PathBuf) -> CfBuildBuilder<SetOutputPrefix<S>>
where S::OutputPrefix: IsUnset,

Required.

Source

pub fn k(self, value: usize) -> CfBuildBuilder<SetK<S>>
where S::K: IsUnset,

Optional (Some / Option setters). Default: 31.

Source

pub fn maybe_k(self, value: Option<usize>) -> CfBuildBuilder<SetK<S>>
where S::K: IsUnset,

Optional (Some / Option setters). Default: 31.

Source

pub fn threads(self, value: usize) -> CfBuildBuilder<SetThreads<S>>
where S::Threads: IsUnset,

Optional (Some / Option setters). Default: 1.

Source

pub fn maybe_threads( self, value: Option<usize>, ) -> CfBuildBuilder<SetThreads<S>>
where S::Threads: IsUnset,

Optional (Some / Option setters). Default: 1.

Source

pub fn work_dir(self, value: PathBuf) -> CfBuildBuilder<SetWorkDir<S>>
where S::WorkDir: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_work_dir( self, value: Option<PathBuf>, ) -> CfBuildBuilder<SetWorkDir<S>>
where S::WorkDir: IsUnset,

Optional (Some / Option setters).

Source

pub fn num_bins(self, value: usize) -> CfBuildBuilder<SetNumBins<S>>
where S::NumBins: IsUnset,

Optional (Some / Option setters). Default: 128.

Source

pub fn maybe_num_bins( self, value: Option<usize>, ) -> CfBuildBuilder<SetNumBins<S>>
where S::NumBins: IsUnset,

Optional (Some / Option setters). Default: 128.

Source

pub fn memory_budget_gb( self, value: f64, ) -> CfBuildBuilder<SetMemoryBudgetGb<S>>
where S::MemoryBudgetGb: IsUnset,

Optional (Some / Option setters). Default: 4.0.

Source

pub fn maybe_memory_budget_gb( self, value: Option<f64>, ) -> CfBuildBuilder<SetMemoryBudgetGb<S>>
where S::MemoryBudgetGb: IsUnset,

Optional (Some / Option setters). Default: 4.0.

Auto Trait Implementations§

§

impl<S> UnwindSafe for CfBuildBuilder<S>

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> CastableFrom<T> for T

Source §

fn cast_from(value: T) -> T

Call Self as W

Source §

impl<T, U> CastableInto for T
where U: CastableFrom<T>,

Source §

fn cast(self) -> U

Call W::cast_from(self)

Source §

impl<T> DowncastableFrom<T> for T

Source §

fn downcast_from(value: T) -> T

Truncate the current UnsignedInt to a possibly smaller size

Source §

impl<T, U> DowncastableInto for T
where U: DowncastableFrom<T>,

Source §

fn downcast(self) -> U

Call W::downcast_from(self)

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 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> Pointable for T

Source §

const ALIGN: usize

The alignment of pointer.

Source §

type Init = T

The type for initializers.

Source §

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

Source §

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

Source §

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

Source §

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

Source §

impl<T> Splat<T> for T

Source §

fn splat(value: T) -> T

Source §

impl<T> To<T> for T

Source §

fn to(self) -> T

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<T> UpcastableFrom<T> for T

Source §

fn upcast_from(value: T) -> T

Extend the current UnsignedInt to a possibly bigger size.

Source §

impl<T, U> UpcastableInto for T
where U: UpcastableFrom<T>,

Source §

fn upcast(self) -> U

Call W::upcast_from(self)

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

CfBuildBuilder

Struct CfBuildBuilder Copy item path

Implementations§

impl<S: State> CfBuildBuilder<S>

pub fn call(self) -> Result<CfBuildResult>where S: IsComplete,

pub fn input(self, value: CfInput) -> CfBuildBuilder<SetInput<S>>where S::Input: IsUnset,

pub fn output_prefix(self, value: PathBuf) -> CfBuildBuilder<SetOutputPrefix<S>>where S::OutputPrefix: IsUnset,

pub fn k(self, value: usize) -> CfBuildBuilder<SetK<S>>where S::K: IsUnset,

pub fn maybe_k(self, value: Option<usize>) -> CfBuildBuilder<SetK<S>>where S::K: IsUnset,

pub fn threads(self, value: usize) -> CfBuildBuilder<SetThreads<S>>where S::Threads: IsUnset,

pub fn maybe_threads( self, value: Option<usize>, ) -> CfBuildBuilder<SetThreads<S>>where S::Threads: IsUnset,

pub fn work_dir(self, value: PathBuf) -> CfBuildBuilder<SetWorkDir<S>>where S::WorkDir: IsUnset,

pub fn maybe_work_dir( self, value: Option<PathBuf>, ) -> CfBuildBuilder<SetWorkDir<S>>where S::WorkDir: IsUnset,

pub fn num_bins(self, value: usize) -> CfBuildBuilder<SetNumBins<S>>where S::NumBins: IsUnset,

pub fn maybe_num_bins( self, value: Option<usize>, ) -> CfBuildBuilder<SetNumBins<S>>where S::NumBins: IsUnset,

pub fn memory_budget_gb( self, value: f64, ) -> CfBuildBuilder<SetMemoryBudgetGb<S>>where S::MemoryBudgetGb: IsUnset,

pub fn maybe_memory_budget_gb( self, value: Option<f64>, ) -> CfBuildBuilder<SetMemoryBudgetGb<S>>where S::MemoryBudgetGb: IsUnset,

Auto Trait Implementations§

impl<S> Freeze for CfBuildBuilder<S>

impl<S> RefUnwindSafe for CfBuildBuilder<S>

impl<S> Send for CfBuildBuilder<S>

impl<S> Sync for CfBuildBuilder<S>

impl<S> Unpin for CfBuildBuilder<S>

impl<S> UnsafeUnpin for CfBuildBuilder<S>

impl<S> UnwindSafe for CfBuildBuilder<S>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CastableFrom<T> for T

fn cast_from(value: T) -> T

impl<T, U> CastableInto<U> for Twhere U: CastableFrom<T>,

fn cast(self) -> U

impl<T> DowncastableFrom<T> for T

fn downcast_from(value: T) -> T

impl<T, U> DowncastableInto<U> for Twhere U: DowncastableFrom<T>,

fn downcast(self) -> U

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Splat<T> for T

fn splat(value: T) -> T

impl<T> To<T> for T

fn to(self) -> T

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

type Error = Infallible

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

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

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

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

impl<T> UpcastableFrom<T> for T

fn upcast_from(value: T) -> T

impl<T, U> UpcastableInto<U> for Twhere U: UpcastableFrom<T>,

fn upcast(self) -> U

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct CfBuildBuilder

pub fn call(self) -> Result<CfBuildResult>
where S: IsComplete,

pub fn input(self, value: CfInput) -> CfBuildBuilder<SetInput<S>>
where S::Input: IsUnset,

pub fn output_prefix(self, value: PathBuf) -> CfBuildBuilder<SetOutputPrefix<S>>
where S::OutputPrefix: IsUnset,

pub fn k(self, value: usize) -> CfBuildBuilder<SetK<S>>
where S::K: IsUnset,

pub fn maybe_k(self, value: Option<usize>) -> CfBuildBuilder<SetK<S>>
where S::K: IsUnset,

pub fn threads(self, value: usize) -> CfBuildBuilder<SetThreads<S>>
where S::Threads: IsUnset,

pub fn maybe_threads( self, value: Option<usize>, ) -> CfBuildBuilder<SetThreads<S>>
where S::Threads: IsUnset,

pub fn work_dir(self, value: PathBuf) -> CfBuildBuilder<SetWorkDir<S>>
where S::WorkDir: IsUnset,

pub fn maybe_work_dir( self, value: Option<PathBuf>, ) -> CfBuildBuilder<SetWorkDir<S>>
where S::WorkDir: IsUnset,

pub fn num_bins(self, value: usize) -> CfBuildBuilder<SetNumBins<S>>
where S::NumBins: IsUnset,

pub fn maybe_num_bins( self, value: Option<usize>, ) -> CfBuildBuilder<SetNumBins<S>>
where S::NumBins: IsUnset,

pub fn memory_budget_gb( self, value: f64, ) -> CfBuildBuilder<SetMemoryBudgetGb<S>>
where S::MemoryBudgetGb: IsUnset,

pub fn maybe_memory_budget_gb( self, value: Option<f64>, ) -> CfBuildBuilder<SetMemoryBudgetGb<S>>
where S::MemoryBudgetGb: IsUnset,

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

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

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

impl<T, U> CastableInto<U> for T
where U: CastableFrom<T>,

impl<T, U> DowncastableInto<U> for T
where U: DowncastableFrom<T>,

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

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

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

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

impl<T, U> UpcastableInto<U> for T
where U: UpcastableFrom<T>,

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

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