Struct wick_packet::Packet

pub struct Packet {
    pub payload: PacketPayload,
    /* private fields */
}

Fields

payload: PacketPayload

Implementations

impl Packet

pub const FATAL_ERROR: &str = "<error>"

The port name that indicates a component-wide fatal error.

pub const NO_INPUT: &str = "<>"

pub const fn new_raw( payload: PacketPayload, wasmrs: Metadata, metadata: WickMetadata ) -> Self

Create a new packet for the given port with a raw PacketPayload, wasmRS Metadata, and WickMetadata.

pub fn new_for_port<T: Into<String>>( port: T, payload: PacketPayload, flags: u8 ) -> Self

Create a new packet for the given port with a raw PacketPayload value and given flags.

pub fn no_input() -> Self

pub fn component_error<T: Into<String>>(err: T) -> Self

Create a new fatal error packet for the component.

pub fn ok<T: Into<String>>(port: T, payload: RawPayload) -> Self

Create a new success packet for the given port with a raw RawPayload value.

pub fn raw_err<T: Into<String>>(port: T, payload: PacketError) -> Self

Create a new error packet for the given port with a raw PacketError value.

pub fn err<T: Into<String>, E: Into<String>>(port: T, msg: E) -> Self

Create a new error packet for the given port.

pub fn done<T: Into<String>>(port: T) -> Self

Create a new done packet for the given port.

pub fn open_bracket<T: Into<String>>(port: T) -> Self

Create a new open bracket packet for the given port.

pub fn close_bracket<T: Into<String>>(port: T) -> Self

Create a close bracket packet for the given port.

pub fn context(&self) -> Option<Base64Bytes>

Get the context of a crate::ContextTransport on this packet.

pub fn set_context(&mut self, context: Base64Bytes)

Set the content of a crate::ContextTransport on this packet.

pub fn encode<P: Into<String>, T: Serialize>(port: P, data: T) -> Self

Encode a value into a Packet for the given port.

pub const fn index(&self) -> Option<u32>

Get the operation index associated with this packet.

pub fn decode<T: DeserializeOwned>(&self) -> Result<T, Error>

Try to deserialize a Packet into the target type.

pub fn to_type_wrapper(self, ty: Type) -> Result<TypeWrapper, Error>

Partially decode a Packet and wrap it into a TypeWrapper.

pub fn decode_value(&self) -> Result<Value, Error>

Decode a Packet into a serde_json::Value.

pub fn to_port<T: Into<String>>(self, port: T) -> Self

Set the port for this packet.

pub fn set_port<T: Into<String>>(&mut self, port: T)

Set the port for this packet.

pub const fn is_error(&self) -> bool

Return true if this is an error packet.

pub const fn payload(&self) -> &PacketPayload

Get the inner payload of this packet.

pub fn unwrap_payload(self) -> Option<Base64Bytes>

Returns the payload, panicking if it is an error.

pub fn unwrap_err(self) -> PacketError

Returns the error, panicking if the packet was a success packet.

pub fn to_json(&self) -> Value

Return a simplified JSON representation of this packet.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Packet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Packet> for Result<RawPayload, PayloadError>

fn from(value: Packet) -> Self

Converts to this type from the input type.

impl From<Payload> for Packet

fn from(value: Payload) -> Self

Converts to this type from the input type.

impl From<Result<Payload, PayloadError>> for Packet

fn from(p: Result<Payload, PayloadError>) -> Self

Converts to this type from the input type.

impl From<Result<RawPayload, PayloadError>> for Packet

fn from(p: Result<RawPayload, PayloadError>) -> Self

Converts to this type from the input type.

impl PacketExt for Packet

fn has_data(&self) -> bool

Returns true if the packet contains data in the payload.

fn port(&self) -> &str

Get the port for this packet.

fn flags(&self) -> u8

Get the inner payload of this packet.

fn is_noop(&self) -> bool

Return true if this is a No-Op packet. No action should be taken.

fn is_fatal_error(&self) -> bool

Return true if this is a fatal, component wide error packet.

fn is_signal(&self) -> bool

Returns true if this packet is a signal packet (i.e. done, open_bracket, close_bracket, etc).

fn is_bracket(&self) -> bool

Returns true if this packet is a bracket packet (i.e open_bracket, close_bracket, etc).

fn is_done(&self) -> bool

Returns true if this packet is a done packet.

fn is_open_bracket(&self) -> bool

Returns true if this packet is an open bracket packet.

fn is_close_bracket(&self) -> bool

Returns true if this packet is a close bracket packet.

impl PartialEq for Packet

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Packet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.