Struct ClientRequest 

#[non_exhaustive]
pub struct ClientRequest<T> { /* private fields */ }

Typed request envelope shared by browser, desktop and mobile clients.

Implementations

impl<T> ClientRequest<T>

pub fn new(version: ContractVersion, request_id: RequestId, payload: T) -> Self

Creates a read/non-replay-sensitive request envelope.

pub fn mutation( version: ContractVersion, request_id: RequestId, idempotency_key: IdempotencyKey, payload: T, ) -> Self

Creates a mutation envelope carrying a validated replay key.

pub const fn version(&self) -> ContractVersion

Returns the requested wire version.

pub fn request_id(&self) -> &RequestId

Returns the correlation identifier; it is never authorization evidence.

pub fn idempotency_key(&self) -> Option<&IdempotencyKey>

Returns the optional mutation replay key.

pub fn require_idempotency_key( &self, ) -> Result<&IdempotencyKey, ClientContractError>

Requires a replay key before a server executes a mutation.

pub fn payload(&self) -> &T

Returns a reference to the application payload.

pub fn into_payload(self) -> T

Consumes the envelope and returns the application payload.

Trait Implementations

impl<T: Clone> Clone for ClientRequest<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ClientRequest<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ClientRequest<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for ClientRequest<T>

impl<T: PartialEq> PartialEq for ClientRequest<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for ClientRequest<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for ClientRequest<T>