Struct binate::prelude::Payload

pub struct Payload { /* fields omitted */ }

Payload of a RSocket frame.

Examples

use binate::prelude::*;

let payload = Payload::builder().set_data("data").set_metadata("metadata").build();
assert_eq!(payload.data().unwrap(), "data");
assert_eq!(payload.metadata().unwrap(), "metadata");

Implementations

impl Payload

pub fn builder() -> PayloadBuilder

This is supported on crate feature frame only.

Returns a payload builder.

pub fn len(&self) -> usize

This is supported on crate feature frame only.

Returns the number of bytes in this payload.

pub fn is_empty(&self) -> bool

This is supported on crate feature frame only.

Returns true if this payload is empty.

pub fn data(&self) -> Option<&Data>

This is supported on crate feature frame only.

Returns the data part of this payload.

pub fn metadata(&self) -> Option<&Metadata>

This is supported on crate feature frame only.

Returns the metadata part of this payload.

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

This is supported on crate feature frame only.

Returns the data part of this payload in UTF-8 format, if the data is valid UTF-8.

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

This is supported on crate feature frame only.

Returns the metadata part of this payload in UTF-8 format, if the metadata is valid UTF-8.

pub fn has_data(&self) -> bool

This is supported on crate feature frame only.

Returns true if this payload contains data.

pub fn has_metadata(&self) -> bool

This is supported on crate feature frame only.

Returns true if this payload contains metadata.

pub fn split(self) -> (Option<Metadata>, Option<Data>)

This is supported on crate feature frame only.

Splits the payload into Metadata and Data.

pub fn chunks(self, mtu: usize) -> PayloadChunks

This is supported on crate feature frame only.

Returns a consuming iterator that yields mtu bytes of the payload at a time (both metadata and data are chunked by mtu).

If mtu does not divide the the metadata and data of the payload, then the last chunk will not have length mtu.

Trait Implementations

impl Clone for Payload

This is supported on crate feature frame only.

fn clone(&self) -> Payload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

This is supported on crate feature frame only.

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

Formats the value using the given formatter.

impl Default for Payload

This is supported on crate feature frame only.

fn default() -> Payload

Returns the “default value” for a type.

impl Encode for Payload

This is supported on crate feature frame only.

fn encode(&self, buf: &mut BytesMut)

Encodes self into bytes.

fn len(&self) -> usize

Returns the length (in bytes) of this value.

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn to_bytes(&self) -> Bytes

Encodes self into bytes.

impl PartialEq<Payload> for Payload

This is supported on crate feature frame only.

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

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

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

This method tests for !=.

impl Eq for Payload

This is supported on crate feature frame only.

impl StructuralEq for Payload

This is supported on crate feature frame only.

impl StructuralPartialEq for Payload

This is supported on crate feature frame only.