Skip to main content

DebugSubscriptionEvent

Struct DebugSubscriptionEvent 

Source
pub struct DebugSubscriptionEvent {
    pub data: DebugSubscriptionData,
}
Expand description

A typed debug subscription event.

The wire representation is a VarInt DebugSubscriptionType followed by the payload selected by that type. The discriminator is derived from data, so an event cannot contain mismatched type and data.

§Examples

use mcproto_types::{
    DebugSubscriptionData, DebugSubscriptionEvent, EntityBlockIntersectionDebugData,
    EntityBlockIntersectionState, TypeCodec,
};

let event = DebugSubscriptionEvent::new(
    DebugSubscriptionData::EntityBlockIntersection(
        EntityBlockIntersectionDebugData {
            state: EntityBlockIntersectionState::InFluid,
        },
    ),
);
let mut encoded = Vec::new();
event.encode(&mut encoded)?;
assert_eq!(encoded, [0x06, 0x01]);
assert_eq!(DebugSubscriptionEvent::decode(&mut encoded.as_slice())?, event);

See the official Debug Subscription Event documentation.

Fields§

§data: DebugSubscriptionData

Payload and its associated subscription type.

Implementations§

Source§

impl DebugSubscriptionEvent

Source

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

Creates an event from a typed payload.

Source

pub const fn subscription_type(&self) -> DebugSubscriptionType

Returns the discriminator associated with this event.

Trait Implementations§

Source§

impl Clone for DebugSubscriptionEvent

Source§

fn clone(&self) -> DebugSubscriptionEvent

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 DebugSubscriptionEvent

Source§

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

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

impl From<DebugSubscriptionData> for DebugSubscriptionEvent

Source§

fn from(data: DebugSubscriptionData) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for DebugSubscriptionEvent

Source§

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

Source§

impl TypeCodec for DebugSubscriptionEvent

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.