Struct ethox::wire::payload

#[repr(transparent)]
pub struct payload(_);

A dynamically sized type representing a packet payload.

This type is seemingly just a [u8]. It is a newtype wrapper so that this crate can freely implement traits for it but also restrict the standard trait implementations to not be available.

To create a payload use the provided From trait impls, to convert it back you can use either of the synonyms as_bytes or as_slice, and their mutable variants.

Methods

impl payload

pub fn as_bytes(&self) -> &[u8]

Converts this payload to a standard byte slice. This is a no-op pointer conversion.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Converts this payload to a mutable byte slice. This is a no-op pointer conversion.

pub fn as_slice(&self) -> &[u8]

Converts this payload to a standard byte slice. This is a no-op pointer conversion.

pub fn as_mut_slice(&mut self) -> &mut [u8]

Converts this payload to a mutable byte slice. This is a no-op pointer conversion.

Trait Implementations

impl AsMut<[u8]> for payload

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl AsRef<[u8]> for payload

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Debug for payload

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

Formats the value using the given formatter.

impl Deref for payload

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl DerefMut for payload

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.

impl Eq for payload

impl<'a> From<&'a [u8]> for &'a payload

fn from(val: &'a [u8]) -> &'a payload

Performs the conversion.

impl<'a> From<&'a mut [u8]> for &'a mut payload

fn from(val: &'a mut [u8]) -> &'a mut payload

Performs the conversion.

impl<'a> From<&'a mut payload> for &'a mut [u8]

fn from(val: &'a mut payload) -> &'a mut [u8]

Performs the conversion.

impl<'a> From<&'a payload> for &'a [u8]

fn from(val: &'a payload) -> &'a [u8]

Performs the conversion.

impl Ord for payload

fn cmp(&self, other: &payload) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<payload> for payload

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 PartialOrd<payload> for payload

fn partial_cmp(&self, other: &payload) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &payload) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &payload) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &payload) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &payload) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Payload for payload

fn payload(&self) -> &payload

Get the bytes wrapped in the payload newtype.

impl PayloadMut for payload

fn payload_mut(&mut self) -> &mut payload

Retrieve the mutable, inner payload.

fn resize(&mut self, len: usize) -> Result<(), Error>

Resize the payload.

fn reframe(&mut self, reframe: Reframe) -> Result<(), Error>

Resize the payload while keeping some data.

impl StructuralEq for payload

impl StructuralPartialEq for payload