Struct icu_provider::DataResponse

source ·
pub struct DataResponse<M>
where M: DataMarker,
{ pub metadata: DataResponseMetadata, pub payload: Option<DataPayload<M>>, }
Expand description

A response object containing an object as payload and metadata about it.

Fields§

§metadata: DataResponseMetadata

Metadata about the returned object.

§payload: Option<DataPayload<M>>

The object itself; None if it was not loaded.

Implementations§

source§

impl<M> DataResponse<M>
where M: DataMarker,

source

pub fn take_payload(self) -> Result<DataPayload<M>, DataError>

Takes ownership of the underlying payload. Error if not present.

To take the metadata, too, use Self::take_metadata_and_payload().

source

pub fn take_metadata_and_payload( self ) -> Result<(DataResponseMetadata, DataPayload<M>), DataError>

Takes ownership of the underlying metadata and payload. Error if payload is not present.

source

pub fn cast<M2>(self) -> DataResponse<M2>
where M2: DataMarker<Yokeable = M::Yokeable>,

Convert between two DataMarker types that are compatible with each other with compile-time type checking.

This happens if they both have the same DataMarker::Yokeable type.

Can be used to erase the key of a data payload in cases where multiple keys correspond to the same data struct.

For runtime dynamic casting, use DataPayload::dynamic_cast_mut().

source§

impl<M> DataResponse<M>

source

pub fn wrap_into_any_response(self) -> AnyResponse

Moves the inner DataPayload to the heap (requiring an allocation) and returns it as an erased AnyResponse.

Trait Implementations§

source§

impl<M> Clone for DataResponse<M>
where M: DataMarker, for<'a> YokeTraitHack<<M::Yokeable as Yokeable<'a>>::Output>: Clone,

Cloning a DataResponse is generally a cheap operation. See notes in the Clone impl for Yoke.

§Examples

use icu_provider::hello_world::*;
use icu_provider::prelude::*;

let resp1: DataResponse<HelloWorldV1Marker> = todo!();
let resp2 = resp1.clone();
source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<M> Debug for DataResponse<M>
where M: DataMarker, for<'a> &'a <M::Yokeable as Yokeable<'a>>::Output: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl From<AnyResponse> for DataResponse<AnyMarker>

source§

fn from(other: AnyResponse) -> Self

Converts to this type from the input type.
source§

impl TryFrom<DataResponse<AnyMarker>> for AnyResponse

§

type Error = DataError

The type returned in the event of a conversion error.
source§

fn try_from(other: DataResponse<AnyMarker>) -> Result<Self, Self::Error>

Performs the conversion.
source§

impl<M> TryFrom<DataResponse<M>> for DataPayload<M>
where M: DataMarker,

§

type Error = DataError

The type returned in the event of a conversion error.
source§

fn try_from(response: DataResponse<M>) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<M> Freeze for DataResponse<M>
where <M as DataMarker>::Yokeable: Freeze,

§

impl<M> RefUnwindSafe for DataResponse<M>

§

impl<M> Send for DataResponse<M>
where <M as DataMarker>::Yokeable: Sync + Send,

§

impl<M> Sync for DataResponse<M>
where <M as DataMarker>::Yokeable: Sync,

§

impl<M> Unpin for DataResponse<M>
where <M as DataMarker>::Yokeable: Unpin,

§

impl<M> UnwindSafe for DataResponse<M>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T
where T: Send + Sync,