Struct BoxRunnable 

pub struct BoxRunnable<E> { /* private fields */ }

Box-based one-time runnable.

BoxRunnable<E> stores a Box<dyn FnOnce() -> Result<(), E>> and can be executed only once. It is the boxed concrete implementation of Runnable.

Type Parameters

• E - The error value returned when the action fails.

Examples

use qubit_function::{BoxRunnable, Runnable};

let task = BoxRunnable::new(|| Ok::<(), String>(()));
assert_eq!(task.run(), Ok(()));

Author

Haixing Hu

Implementations

impl<E> BoxRunnable<E>

pub fn new<F>(function: F) -> Self

where F: FnOnce() -> Result<(), E> + 'static,

Creates a new boxed runnable.

Parameters

• function - The one-time closure executed by this runnable.

Returns

A new unnamed BoxRunnable<E>.

pub fn new_with_name<F>(name: &str, function: F) -> Self

where F: FnOnce() -> Result<(), E> + 'static,

Creates a new named boxed runnable.

Parameters

• name - Name used by Debug and Display.
• function - The one-time closure executed by this runnable.

Returns

A new named BoxRunnable<E>.

pub fn new_with_optional_name<F>(function: F, name: Option<String>) -> Self

where F: FnOnce() -> Result<(), E> + 'static,

Creates a new boxed runnable with an optional name.

Parameters

• function - The one-time closure executed by this runnable.
• name - Optional name used by Debug and Display.

Returns

A new BoxRunnable<E>.

pub fn from_supplier<S>(supplier: S) -> Self

where S: SupplierOnce<Result<(), E>> + 'static,

Creates a boxed runnable from a one-time supplier.

This is an explicit bridge from SupplierOnce<Result<(), E>> to Runnable<E>.

Parameters

• supplier - The supplier that produces the runnable result.

Returns

A new BoxRunnable<E>.

pub fn name(&self) -> Option<&str>

Gets the optional runnable name.

Returns

Returns Some(&str) if a name was set, or None otherwise.

pub fn set_name(&mut self, name: &str)

Sets the runnable name.

Parameters

• name - The new name.

pub fn clear_name(&mut self)

Clears the runnable name.

pub fn and_then<N>(self, next: N) -> BoxRunnable<E>

where N: Runnable<E> + 'static, E: 'static,

Chains another runnable after this runnable succeeds.

The second runnable is not executed if this runnable returns Err.

Parameters

• next - The runnable to execute after this runnable succeeds.

Returns

A new runnable executing both actions in sequence.

pub fn then_callable<R, C>(self, callable: C) -> BoxCallable<R, E>

where C: Callable<R, E> + 'static, R: 'static, E: 'static,

Runs this runnable before a callable.

The callable is not executed if this runnable returns Err.

Parameters

• callable - The callable to execute after this runnable succeeds.

Returns

A callable producing the second computation’s result.

Trait Implementations

impl<E> Debug for BoxRunnable<E>

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

Formats this boxed runnable for debugging.

impl<E> Display for BoxRunnable<E>

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

Formats this boxed runnable for display.

impl<E> Runnable<E> for BoxRunnable<E>

fn run(self) -> Result<(), E>

Executes the boxed runnable.

fn into_box(self) -> BoxRunnable<E>

Returns this boxed runnable without re-boxing it.

fn into_fn(self) -> impl FnOnce() -> Result<(), E>

Extracts the underlying one-time closure.

fn into_callable(self) -> BoxCallable<(), E>

where Self: Sized + 'static,

Converts this boxed runnable into a boxed callable while preserving its name.

impl<E> SupplierOnce<Result<(), E>> for BoxRunnable<E>

fn get(self) -> Result<(), E>

Executes the boxed runnable as a one-time supplier of Result<(), E>.

fn into_box(self) -> BoxSupplierOnce<T>

where Self: Sized + 'static,

Converts to BoxSupplierOnce.

fn into_fn(self) -> impl FnOnce() -> T

where Self: Sized + 'static,

Converts the supplier to a Box<dyn FnOnce() -> T>.