Enum Payload 

pub enum Payload {
    Json(Value),
    Binary(Vec<u8>),
    Reply {
        status: String,
        response: Box<Payload>,
    },
}

Payload carried by a Phoenix protocol frame.

Variants

Json(Value)

An ordinary JSON payload.

Binary(Vec<u8>)

An opaque binary payload.

Reply

The status and response object inside a phx_reply frame.

Fields

status: String

Phoenix reply status string, normally ok or error.

response: Box<Payload>

JSON or binary response returned by the server.

Implementations

impl Payload

pub fn as_json(&self) -> Option<&Value>

Borrows the JSON value when this is Payload::Json.

pub fn as_binary(&self) -> Option<&[u8]>

Borrows the bytes when this is Payload::Binary.

pub fn into_json(self) -> Result<Value, Self>

Consumes this payload and returns its JSON value.

Returns the original payload when it is not JSON.

pub fn into_binary(self) -> Result<Vec<u8>, Self>

Consumes this payload and returns its binary bytes.

Returns the original payload when it is not binary.

pub fn deserialize<T: DeserializeOwned>(&self) -> Result<T, PayloadError>

Deserializes a JSON payload into T.

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl From<Value> for Payload

fn from(value: Value) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Payload

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl PartialEq<Value> for Payload

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Payload

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Payload