Struct Subscriptions 

#[repr(transparent)]
pub struct Subscriptions([u8]);

Borrowed view over a validated SUBSCRIBE payload.

Each entry is a length-prefixed topic filter followed by an options byte (§3.8.3). Use SubscriptionsBuf to build one, or Subscriptions::new to validate and borrow existing encoded bytes.

Tuple Fields

0: [u8]

Implementations

impl Subscriptions

pub const EMPTY: &'static Self

An empty subscriptions payload.

pub const fn new(bytes: &[u8]) -> Result<&Self, DecodeError>

Validates raw SUBSCRIBE payload bytes and returns a Subscriptions reference.

Errors

Returns DecodeError if any entry is malformed: a truncated topic filter string, an invalid topic filter, or an invalid options byte.

pub const unsafe fn new_unchecked(bytes: &[u8]) -> &Self

Creates a Subscriptions reference from raw bytes WITHOUT validation.

Safety

The caller must guarantee that bytes contains only structurally valid subscription entries: each is a length-prefixed valid topic filter followed by a valid options byte.

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

Returns the raw encoded bytes.

pub const fn is_empty(&self) -> bool

Returns true if the payload contains no subscription entries.

pub const fn iter(&self) -> SubscriptionIter<'_>

Iterates over the subscription entries in this payload.

Trait Implementations

impl AsRef<Subscriptions> for SubscriptionsBuf

Available on crate feature alloc only.

fn as_ref(&self) -> &Subscriptions

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Subscriptions> for SubscriptionsBuf

Available on crate feature alloc only.

fn borrow(&self) -> &Subscriptions

Immutably borrows from an owned value.

impl Debug for Subscriptions

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

Formats the value using the given formatter.

impl Hash for Subscriptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl<'a> IntoIterator for &'a Subscriptions

type Item = Subscription<'a>

The type of the elements being iterated over.

type IntoIter = SubscriptionIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Subscriptions

fn eq(&self, other: &Subscriptions) -> 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 ToOwned for Subscriptions

Available on crate feature alloc only.

type Owned = SubscriptionsBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for Subscriptions

impl StructuralPartialEq for Subscriptions