Trait Encode

Source

pub trait Encode {
    // Required method
    fn encode(&self, w: impl Write) -> Result<()>;

    // Provided method
    fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>
       where Self: Sized { ... }
}

Expand description

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

§Deriving

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

For enums, the variant to encode is marked 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::Encode;

#[derive(Encode)]
struct MyStruct<'a> {
    first: i32,
    second: &'a str,
    third: [f64; 3],
}

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

let value = MyStruct {
    first: 10,
    second: "hello",
    third: [1.5, 3.14, 2.718],
};

let mut buf = vec![];
value.encode(&mut buf).unwrap();

println!("{buf:?}");

Required Methods§

Source

fn encode(&self, w: impl Write) -> Result<()>

Writes this object to the provided writer.

If this type also implements Decode then successful calls to this function returning Ok(()) must always successfully decode using the data that was written to the writer. The exact number of bytes that were originally written must be consumed during the decoding.

Provided Methods§

Source

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>
where Self: Sized,

Like Encode::encode, except that a whole slice of values is encoded.

This method must be semantically equivalent to encoding every element of the slice in sequence with no leading length prefix (which is exactly what the default implementation does), but a more efficient implementation may be used.

This method is important for some types like u8 where the entire slice can be encoded in a single call to write_all. Because impl specialization is unavailable in stable Rust at the time of writing, we must make the slice specialization part of this trait.

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 Encode Copy item path

§Deriving

Required Methods§

fn encode(&self, w: impl Write) -> Result<()>

Provided Methods§

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>where Self: Sized,

Dyn Compatibility§

Implementations on Foreign Types§

impl Encode for EntityAttribute

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for EntityAttributeOperation

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for BlockEntityKind

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for BlockKind

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for ItemKind

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for bool

fn encode(&self, w: impl Write) -> Result<()>

fn encode_slice(slice: &[bool], w: impl Write) -> Result<()>

impl Encode for f32

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for f64

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for i8

fn encode(&self, w: impl Write) -> Result<()>

fn encode_slice(slice: &[i8], w: impl Write) -> Result<()>

impl Encode for i16

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for i32

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for i64

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for i128

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for str

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for u8

fn encode(&self, w: impl Write) -> Result<()>

fn encode_slice(slice: &[u8], w: impl Write) -> Result<()>

impl Encode for u16

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for u32

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for u64

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for u128

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for ()

fn encode(&self, _w: impl Write) -> Result<()>

impl Encode for BlockState

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for RegistryId

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Compound

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for NetworkCompound

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for RgbColor

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for JsonText

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Text

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for String

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Quat

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Vec3A

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Vec4

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Vec2

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for Vec3

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for DQuat

fn encode(&self, w: impl Write) -> Result<()>

impl Encode for DVec2

Trait Encode

fn encode_slice(slice: &[Self], w: impl Write) -> Result<()>
where Self: Sized,

impl<B> Encode for Cow<'_, B>
where B: ToOwned + Encode + ?Sized,

impl<K, V> Encode for BTreeMap<K, V>
where K: Encode, V: Encode,

impl<K, V, S> Encode for HashMap<K, V, S>
where K: Encode, V: Encode,

impl<T> Encode for BTreeSet<T>
where T: Encode,

impl<T, S> Encode for HashSet<T, S>
where T: Encode,