Struct BoxRunnableOnce 

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

Box-based one-time runnable.

BoxRunnableOnce<E> stores a Box<dyn FnOnce() -> Result<(), E> + Send> and can be executed only once. It is the boxed concrete implementation of RunnableOnce for task objects that may be moved across threads.

Type Parameters

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

Examples

use qubit_function::{BoxRunnableOnce, RunnableOnce};

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

Implementations

impl<E> BoxRunnableOnce<E>

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

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

Creates a new runnable.

Wraps the provided closure in the appropriate smart pointer type for this runnable implementation.

Examples found in repository

examples/tasks/task_demo.rs (lines 81-84)

fn demo_once_tasks() {
    println!("--- One-time tasks ---");

    let callable_once = BoxCallableOnce::new(|| Ok::<String, String>(String::from("ready")));
    println!("CallableOnce result: {:?}", callable_once.call());

    let runnable_once = BoxRunnableOnce::new(|| {
        println!("RunnableOnce side effect executed");
        Ok::<(), String>(())
    });
    println!("RunnableOnce result: {:?}", runnable_once.run());
    println!();
}

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

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

Creates a new named runnable.

Wraps the provided closure and assigns it a name, which is useful for debugging and logging purposes.

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

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

Creates a new named runnable with an optional name.

Wraps the provided closure and assigns it an optional name.

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

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

Creates a boxed runnable from a one-time supplier.

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

Parameters

• supplier - The supplier that produces the runnable result.

Returns

A new BoxRunnableOnce<E>.

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

Gets the name of this runnable.

Returns

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

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

Sets the name of this runnable.

Parameters

• name - The name to set for this runnable

pub fn clear_name(&mut self)

Clears the name of this runnable.

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

where N: RunnableOnce<E> + Send + '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) -> BoxCallableOnce<R, E>

where C: CallableOnce<R, E> + Send + '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 BoxRunnableOnce<E>

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

Formats the value using the given formatter.

impl<E> Display for BoxRunnableOnce<E>

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

Formats the value using the given formatter.

impl<E> RunnableOnce<E> for BoxRunnableOnce<E>

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

Executes the boxed runnable.

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

where Self: Sized + 'static,

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

fn into_local_box(self) -> LocalBoxRunnableOnce<E>

where Self: Sized + 'static,

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

fn into_local_callable(self) -> LocalBoxCallableOnce<(), E>

where Self: Sized + 'static,

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

fn into_box(self) -> BoxRunnableOnce<E>

Converts this runnable into a boxed runnable.

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

Converts this runnable into a closure.

impl<E> SupplierOnce<Result<(), E>> for BoxRunnableOnce<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>.