Trait Decode

Source

pub trait Decode<'a>: Sized {
    // Required method
    fn decode(r: &mut &'a [u8]) -> Result<Self>;
}

Expand description

The Decode trait allows objects to be read from the Minecraft protocol. It is the inverse of Encode.

Decode is parameterized by a lifetime. This allows the decoded value to borrow data from the byte slice it was read from.

§Deriving

This trait can be implemented automatically for structs and enums by using the Decode derive macro. All components of the type must implement Decode. Components are decoded in the order they appear in the type definition.

For enums, the variant to decode is determined by a leading VarInt discriminant (tag). The discriminant value can be changed using the #[packet(tag = ...)] attribute on the variant in question. Discriminant values are assigned to variants using rules similar to regular enum discriminants.

use chunkedge_binary::Decode;

#[derive(PartialEq, Debug, Decode)]
struct MyStruct {
    first: i32,
    second: MyEnum,
}

#[derive(PartialEq, Debug, Decode)]
enum MyEnum {
    First,  // tag = 0
    Second, // tag = 1
    #[packet(tag = 25)]
    Third, // tag = 25
    Fourth, // tag = 26
}

let mut r: &[u8] = &[0, 0, 0, 0, 26];

let value = MyStruct::decode(&mut r).unwrap();
let expected = MyStruct {
    first: 0,
    second: MyEnum::Fourth,
};

assert_eq!(value, expected);
assert!(r.is_empty());

Required Methods§

Source

fn decode(r: &mut &'a [u8]) -> Result<Self>

Reads this object from the provided byte slice.

Implementations of Decode are expected to shrink the slice from the front as bytes are read.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait Decode Copy item path

§Deriving

Required Methods§

fn decode(r: &mut &'a [u8]) -> Result<Self>

Dyn Compatibility§

Implementations on Foreign Types§

impl Decode<'_> for EntityAttributeOperation

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for BlockKind

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for ItemKind

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for bool

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for f32

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for f64

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for i8

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for i16

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for i32

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for i64

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for i128

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for u8

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for u16

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for u32

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for u64

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for u128

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for BlockState

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Compound

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for NetworkCompound

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for RgbColor

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for JsonText

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Text

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Box<str>

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for String

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Quat

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Vec3A

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Vec4

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Vec2

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for Vec3

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for DQuat

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for DVec2

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for DVec3

fn decode(r: &mut &[u8]) -> Result<Self>

impl Decode<'_> for IVec3

fn decode(r: &mut &[u8]) -> Result<Self>

impl<'a> Decode<'a> for &'a str

fn decode(r: &mut &'a [u8]) -> Result<Self>

impl<'a> Decode<'a> for &'a [i8]

fn decode(r: &mut &'a [u8]) -> Result<Self>

impl<'a> Decode<'a> for &'a [u8]

fn decode(r: &mut &'a [u8]) -> Result<Self>

impl<'a> Decode<'a> for EntityAttribute

fn decode(r: &mut &'a [u8]) -> Result<Self>

Trait Decode

impl<'a, B> Decode<'a> for Cow<'_, B>
where B: ToOwned + ?Sized, B::Owned: Decode<'a>,

impl<'a, K, V> Decode<'a> for BTreeMap<K, V>
where K: Ord + Decode<'a>, V: Decode<'a>,

impl<'a, K, V, S> Decode<'a> for HashMap<K, V, S>
where K: Eq + Hash + Decode<'a>, V: Decode<'a>, S: BuildHasher + Default,

impl<'a, S> Decode<'a> for Ident<S>
where S: Decode<'a>, Ident<S>: TryFrom<S, Error = IdentError>,

impl<'a, T> Decode<'a> for BTreeSet<T>
where T: Ord + Decode<'a>,

impl<'a, T, S> Decode<'a> for HashSet<T, S>
where T: Eq + Hash + Decode<'a>, S: BuildHasher + Default,