Skip to main content

BatchItem

ferrin_spec::batch

Enum BatchItem

#[non_exhaustive]pub enum BatchItem<R> {
    Succeeded {
        id: String,
        result: R,
    },
    Failed {
        id: String,
        error: BatchError,
        provider_metadata: Option<ProviderMetadata>,
    },
    Cancelled {
        id: String,
        error: Option<BatchError>,
        provider_metadata: Option<ProviderMetadata>,
    },
    Expired {
        id: String,
        error: Option<BatchError>,
        provider_metadata: Option<ProviderMetadata>,
    },
}

Expand description

Outcome of one request, tagged by status.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Succeeded

The request succeeded.

Fields

§id: String

Caller-assigned request id.

§result: R

The result.

Failed

The request failed.

Fields

§id: String

Caller-assigned request id.

§error: BatchError

The error.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

Cancelled

The request was cancelled.

Fields

§id: String

Caller-assigned request id.

§error: Option<BatchError>

Error details, if any.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

Expired

The request expired before completion.

Fields

§id: String

Caller-assigned request id.

§error: Option<BatchError>

Error details, if any.

§provider_metadata: Option<ProviderMetadata>

Provider-specific metadata.

Implementations§

impl<R> BatchItem<R>

pub fn id(&self) -> &str

Returns the caller-assigned request id.

Trait Implementations§

impl<R: Clone> Clone for BatchItem<R>

fn clone(&self) -> BatchItem<R>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<R: Debug> Debug for BatchItem<R>

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

Formats the value using the given formatter. Read more

impl<'de, R> Deserialize<'de> for BatchItem<R>
where R: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<R: PartialEq> PartialEq for BatchItem<R>

fn eq(&self, other: &BatchItem<R>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl<R> Serialize for BatchItem<R>
where R: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<R: PartialEq> StructuralPartialEq for BatchItem<R>

Auto Trait Implementations§

impl<R> Freeze for BatchItem<R>
where R: Freeze,

impl<R> RefUnwindSafe for BatchItem<R>
where R: RefUnwindSafe,

impl<R> Send for BatchItem<R>
where R: Send,

impl<R> Sync for BatchItem<R>
where R: Sync,

impl<R> Unpin for BatchItem<R>
where R: Unpin,

impl<R> UnsafeUnpin for BatchItem<R>
where R: UnsafeUnpin,

impl<R> UnwindSafe for BatchItem<R>
where R: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.