Struct Response

Source

pub struct Response<Res> {
    pub inner: Result<Res, Error>,
    pub task_id: TaskId,
    pub attempt: Attempt,
    /* private fields */
}

Expand description

A generic Response struct that wraps the result of a task, containing the outcome (Ok or Err), task metadata such as task_id, attempt, and an internal marker field for future extensions.

§Type Parameters

Res: The successful result type of the response.

§Fields

inner: A Result that holds either the success value of type Res or an Error on failure.
task_id: A TaskId representing the unique identifier for the task.
attempt: An Attempt representing how many attempts were made to complete the task.
_priv: A private marker field to prevent external construction of the Response.

Fields§

§inner: Result<Res, Error>

The result from a task

§task_id: TaskId

The task id

§attempt: Attempt

The current attempt

Implementations§

Source §

impl<Res> Response<Res>

Source

pub fn new(inner: Result<Res, Error>, task_id: TaskId, attempt: Attempt) -> Self

Creates a new Response instance.

§Arguments

inner: A Result holding either a successful response of type Res or an Error.
task_id: A TaskId representing the unique identifier for the task.
attempt: The attempt count when creating this response.

§Returns

A new Response instance.

Source

pub fn success(res: Res, task_id: TaskId, attempt: Attempt) -> Self

Constructs a successful Response.

§Arguments

res: The success value of type Res.
task_id: A TaskId representing the unique identifier for the task.
attempt: The attempt count when creating this response.

§Returns

A Response instance containing the success value.

Source

pub fn failure(error: Error, task_id: TaskId, attempt: Attempt) -> Self

Constructs a failed Response.

§Arguments

error: The Error that occurred.
task_id: A TaskId representing the unique identifier for the task.
attempt: The attempt count when creating this response.

§Returns

A Response instance containing the error.

Source

pub fn is_success(&self) -> bool

Checks if the Response contains a success (Ok).

§Returns

true if the Response is successful, false otherwise.

Source

pub fn is_failure(&self) -> bool

Checks if the Response contains a failure (Err).

§Returns

true if the Response is a failure, false otherwise.

Source

pub fn map<F, T>(&self, f: F) -> Response<T>
where F: FnOnce(&Res) -> T,

Maps the success value (Res) of the Response to another type using the provided function.

§Arguments

f: A function that takes a reference to the success value and returns a new value of type T.

§Returns

A new Response with the transformed success value or the same error.

§Type Parameters

F: A function or closure that takes a reference to a value of type Res and returns a value of type T.
T: The new type of the success value after mapping.