Struct DataResponse

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

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

impl<M> DataResponse<M>

where M: DataMarker,

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().

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.

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().

impl<M> DataResponse<M>

where M: DataMarker, M::Yokeable: MaybeSendSync,

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

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();

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Debug for DataResponse<M>

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

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

Formats the value using the given formatter.

impl From<AnyResponse> for DataResponse<AnyMarker>

fn from(other: AnyResponse) -> Self

Converts to this type from the input type.

impl TryFrom<DataResponse<AnyMarker>> for AnyResponse

type Error = DataError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<M> TryFrom<DataResponse<M>> for DataPayload<M>

where M: DataMarker,

type Error = DataError

The type returned in the event of a conversion error.

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

Performs the conversion.