Struct ActionEffect 

pub struct ActionEffect<TCapability, TError, TOutput> {
    pub Function: Arc<dyn Fn(TCapability) -> Pin<Box<dyn Future<Output = Result<TOutput, TError>> + Send>> + Send + Sync>,
}

An ActionEffect encapsulates an asynchronous operation as a first-class value.

It is a data structure that contains a function. This function, when provided with its required capability (TCapability), produces a Future that will yield the result of the operation. This pattern cleanly separates the definition of an operation from its execution.

Type Parameters

• TCapability: The type of the capability (e.g., Arc<dyn FileSystemReader>) that the effect’s closure requires to run.
• TError: The error type that the effect’s operation can return.
• TOutput: The success output type of the effect’s operation.

Fields

Function: Arc<dyn Fn(TCapability) -> Pin<Box<dyn Future<Output = Result<TOutput, TError>> + Send>> + Send + Sync>

The wrapped asynchronous function. It is stored in an Arc to make the ActionEffect struct itself cheap to clone.

Implementations

impl<TCapability, TError, TOutput> ActionEffect<TCapability, TError, TOutput>

pub fn New( Function: Arc<dyn Fn(TCapability) -> Pin<Box<dyn Future<Output = Result<TOutput, TError>> + Send>> + Send + Sync>, ) -> Self

Creates a new ActionEffect from a given function closure.

pub async fn Apply(&self, Capability: TCapability) -> Result<TOutput, TError>

where TCapability: Clone,

Applies the effect by executing its wrapped function with the provided capability. This is typically called by an ApplicationRunTime.

pub fn map<TNewOutput, F>( self, _Function: F, ) -> ActionEffect<TCapability, TError, TNewOutput>

where TCapability: 'static + Send, TError: 'static, TOutput: 'static + Send, TNewOutput: 'static, F: Fn(TOutput) -> TNewOutput + Send + Sync + 'static + Copy,

Transforms the output of an effect from TOutput to TNewOutput.

Trait Implementations

impl<TCapability, TError, TOutput> Clone for ActionEffect<TCapability, TError, TOutput>

fn clone(&self) -> Self

Clones the ActionEffect. This is a cheap operation as it only clones the Arc pointer to the underlying function.

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

Performs copy-assignment from source.