Enum ResponsePacket

pub enum ResponsePacket<Payload = Box<RawValue>, ErrData = Box<RawValue>> {
    Single(Response<Payload, ErrData>),
    Batch(Vec<Response<Payload, ErrData>>),
}

A ResponsePacket is a Response or a batch of responses.

Variants

Single(Response<Payload, ErrData>)

A single response.

Batch(Vec<Response<Payload, ErrData>>)

A batch of responses.

Implementations

impl ResponsePacket<&RawValue, &RawValue>

pub fn into_owned(self) -> ResponsePacket

Convert this borrowed response packet into an owned packet by copying the data from the deserializer (if necessary).

impl<Payload, ErrData> ResponsePacket<Payload, ErrData>

pub const fn as_single(&self) -> Option<&Response<Payload, ErrData>>

Returns the Response if this packet is ResponsePacket::Single.

pub const fn as_batch(&self) -> Option<&[Response<Payload, ErrData>]>

Returns the batch of Response if this packet is ResponsePacket::Batch.

pub fn single_payload(&self) -> Option<&ResponsePayload<Payload, ErrData>>

Returns the ResponsePayload if this packet is ResponsePacket::Single.

pub fn is_success(&self) -> bool

Returns true if the response payload is a success.

For batch responses, this returns true if all responses are successful.

pub fn is_error(&self) -> bool

Returns true if the response payload is an error.

For batch responses, this returns true there’s at least one error response.

pub fn as_error(&self) -> Option<&ErrorPayload<ErrData>>

Returns the ErrorPayload if the response is an error.

For batch responses, this returns the first error response.

pub fn iter_errors(&self) -> impl Iterator<Item = &ErrorPayload<ErrData>> + '_

Returns an iterator over the ErrorPayloads in the response.

pub fn first_error_code(&self) -> Option<i64>

Returns the first error code in this packet if it contains any error responses.

pub fn first_error_message(&self) -> Option<&str>

Returns the first error message in this packet if it contains any error responses.

pub fn first_error_data(&self) -> Option<&ErrData>

Returns the first error data in this packet if it contains any error responses.

pub const fn responses(&self) -> &[Response<Payload, ErrData>]

Returns a all Response.

pub fn payloads( &self, ) -> impl Iterator<Item = &ResponsePayload<Payload, ErrData>> + '_

Returns an iterator over the responses’ payloads.

pub fn first_payload(&self) -> Option<&ResponsePayload<Payload, ErrData>>

Returns the first ResponsePayload in this packet.

pub fn response_ids(&self) -> impl Iterator<Item = &Id> + '_

Returns an iterator over the responses’ identifiers.

pub fn responses_by_ids<K>( &self, ids: &HashSet<K>, ) -> Vec<&Response<Payload, ErrData>>

where K: Borrow<Id> + Eq + Hash,

Find responses by a list of IDs.

This is intended to be used in conjunction with RequestPacket::subscription_request_ids to identify subscription responses.

Note

• Responses are not guaranteed to be in the same order.
• Responses are not guaranteed to be in the set.
• If the packet contains duplicate IDs, both will be found.

Trait Implementations

impl<Payload: Clone, ErrData: Clone> Clone for ResponsePacket<Payload, ErrData>

fn clone(&self) -> ResponsePacket<Payload, ErrData>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Payload: Debug, ErrData: Debug> Debug for ResponsePacket<Payload, ErrData>

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

Formats the value using the given formatter.

impl<'de, Payload, ErrData> Deserialize<'de> for ResponsePacket<Payload, ErrData>

where Payload: Deserialize<'de>, ErrData: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Payload, ErrData> From<Vec<Response<Payload, ErrData>>> for ResponsePacket<Payload, ErrData>

fn from(value: Vec<Response<Payload, ErrData>>) -> Self

Converts to this type from the input type.

impl<Payload, ErrData> FromIterator<Response<Payload, ErrData>> for ResponsePacket<Payload, ErrData>

fn from_iter<T: IntoIterator<Item = Response<Payload, ErrData>>>( iter: T, ) -> Self

Creates a value from an iterator.