Skip to main content

DebugSubscriptionUpdate

Enum DebugSubscriptionUpdate 

Source
pub enum DebugSubscriptionUpdate {
    Absent(DebugSubscriptionType),
    Present(DebugSubscriptionData),
}
Expand description

A debug subscription type followed by prefixed optional matching data.

Absent writes the type and a false boolean. A Present value writes the payload’s type, a true boolean, and the matching payload. This representation cannot pair one subscription type with another type’s data.

§Examples

use mcproto_types::{
    DebugSubscriptionData, DebugSubscriptionType, DebugSubscriptionUpdate, TypeCodec,
};

let absent = DebugSubscriptionUpdate::absent(DebugSubscriptionType::Bee);
let mut encoded = Vec::new();
absent.encode(&mut encoded)?;
assert_eq!(encoded, [0x01, 0x00]);
assert_eq!(DebugSubscriptionUpdate::decode(&mut encoded.as_slice())?, absent);

let present = DebugSubscriptionUpdate::present(
    DebugSubscriptionData::DedicatedServerTickTime,
);
let mut encoded = Vec::new();
present.encode(&mut encoded)?;
assert_eq!(encoded, [0x00, 0x01]);

See the official Debug Subscription Update documentation.

Variants§

§

Absent(DebugSubscriptionType)

The selected subscription type has no following payload.

§

Present(DebugSubscriptionData)

The selected subscription type is followed by its payload.

Implementations§

Source§

impl DebugSubscriptionUpdate

Source

pub const fn absent(subscription_type: DebugSubscriptionType) -> Self

Creates an update with no payload.

Source

pub const fn present(data: DebugSubscriptionData) -> Self

Creates an update containing matching typed data.

Source

pub const fn subscription_type(&self) -> DebugSubscriptionType

Returns the selected subscription type.

Source

pub const fn data(&self) -> Option<&DebugSubscriptionData>

Returns the payload when present.

Source

pub const fn is_present(&self) -> bool

Returns whether this update contains a payload.

Trait Implementations§

Source§

impl Clone for DebugSubscriptionUpdate

Source§

fn clone(&self) -> DebugSubscriptionUpdate

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DebugSubscriptionUpdate

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for DebugSubscriptionUpdate

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DebugSubscriptionUpdate

Source§

impl TypeCodec for DebugSubscriptionUpdate

Source§

fn encode(&self, writer: &mut impl Write) -> Result<(), CodecError>

Encodes this value to the writer.
Source§

fn decode(reader: &mut impl Read) -> Result<Self, CodecError>

Decodes this value from the reader.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ContextualCodec for T
where T: TypeCodec,

Source§

fn encode_with_context( &self, writer: &mut impl Write, _context: &Context, ) -> Result<(), CodecError>

Encodes this value using context supplied by its enclosing structure.
Source§

fn decode_with_context( reader: &mut impl Read, _context: &Context, ) -> Result<T, CodecError>
where T: Sized,

Decodes this value using context supplied by its enclosing structure.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.