Trait Encoder 

pub trait Encoder {
    // Required methods
    fn encode(&self, writer: &mut BytesMut) -> Result<()>;
    fn is_default(&self) -> bool;
}

Trait for types that can be encoded into the senax binary format.

Implement this trait for your type to enable serialization. Most users should use #[derive(Encode)] instead of manual implementation.

Errors

Returns EncoderError if the value cannot be encoded.

Required Methods

fn encode(&self, writer: &mut BytesMut) -> Result<()>

Encode the value into the given buffer with schema evolution support.

This method includes field IDs and type tags for forward/backward compatibility. Use this when you need schema evolution support.

Arguments

• writer - The buffer to write the encoded bytes into.

fn is_default(&self) -> bool

Returns true if this value equals its default value. Used by #[senax(skip_default)] attribute to skip encoding default values.

Implementations on Foreign Types

impl Encoder for bool

Encodes a bool as a single tag byte: TAG_ZERO for false, TAG_ONE for true.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for char

Encodes a char as its Unicode code point using the same format as u32.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for f32

Encodes an f32 as a scientific notation string.

Note: Pack/Unpack still uses binary format for efficiency. The string format provides better compatibility and readability for Encode/Decode.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for f64

Encodes an f64 as a scientific notation string.

Note: Pack/Unpack still uses binary format for efficiency. The string format provides better compatibility and readability for Encode/Decode.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for i8

Encodes signed integers using bit-inverted encoding for negative values.

• Non-negative values (>= 0) are encoded as unsigned integers
• Negative values use TAG_NEGATIVE and bit-inverted encoding

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for i16

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for i32

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for i64

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for i128

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for isize

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for u8

Encodes unsigned integers using a compact variable-length format.

• Values 0/1 are encoded as TAG_ZERO/TAG_ONE (1 byte)
• 2..=127 are encoded as a single tag byte (1 byte)
• Larger values use TAG_U8, TAG_U16, TAG_U32, TAG_U64, or TAG_U128 with the value in little-endian
• The encoding is stable and compatible across platforms

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for u16

See u8 for format details.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for u32

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for u64

See u32 for format details.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for u128

See u64 for format details.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for ()

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for usize

Encodes usize using the platform’s pointer width, but always as a portable integer format.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for String

Encodes a String as UTF-8 with a length prefix (short strings use a single tag byte).

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl Encoder for Bytes

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<K: Encoder + Ord, V: Encoder> Encoder for BTreeMap<K, V>

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<K: Encoder, V: Encoder> Encoder for HashMap<K, V>

Encodes a map as a length-prefixed sequence of key-value pairs.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder> Encoder for (T0,)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder> Encoder for (T0, T1)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder> Encoder for (T0, T1, T2)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder> Encoder for (T0, T1, T2, T3)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder> Encoder for (T0, T1, T2, T3, T4)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder> Encoder for (T0, T1, T2, T3, T4, T5)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder, T6: Encoder> Encoder for (T0, T1, T2, T3, T4, T5, T6)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder, T6: Encoder, T7: Encoder> Encoder for (T0, T1, T2, T3, T4, T5, T6, T7)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder, T6: Encoder, T7: Encoder, T8: Encoder> Encoder for (T0, T1, T2, T3, T4, T5, T6, T7, T8)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder, T6: Encoder, T7: Encoder, T8: Encoder, T9: Encoder> Encoder for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder, T6: Encoder, T7: Encoder, T8: Encoder, T9: Encoder, T10: Encoder> Encoder for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T0: Encoder, T1: Encoder, T2: Encoder, T3: Encoder, T4: Encoder, T5: Encoder, T6: Encoder, T7: Encoder, T8: Encoder, T9: Encoder, T10: Encoder, T11: Encoder> Encoder for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder + 'static> Encoder for Vec<T>

Encodes a Vec<T> as a length-prefixed sequence.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder + Eq + Hash> Encoder for HashSet<T>

Encodes a set as a length-prefixed sequence of elements.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder + Ord> Encoder for BTreeSet<T>

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder> Encoder for Option<T>

Encodes an Option<T> as a tag byte followed by the value if present.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder> Encoder for &T

Implementation for references - delegates to the referenced value

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder> Encoder for Box<T>

Encodes a Box<T> by encoding the inner value.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder> Encoder for Arc<T>

Encodes an Arc<T> by encoding the inner value.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

impl<T: Encoder, const N: usize> Encoder for [T; N]

Encodes a fixed-size array as a length-prefixed sequence.

fn encode(&self, writer: &mut BytesMut) -> Result<()>

fn is_default(&self) -> bool

Implementors