Crate tlbits

Binary TL-B de/serialization

Example

Consider the following TL-B schema:

tag$10 query_id:uint64 amount:(VarUInteger 16) = Hello;

Let’s first define a struct Hello that holds these parameters:

struct Hello {
    pub query_id: u64,
    pub amount: BigUint,
}

Serialization

To be able to serialize a type to BitWriter, we should implement BitPack on it:

impl BitPack for Hello {
    fn pack<W>(&self, mut writer: W) -> Result<(), W::Error>
        where W: BitWriter,
    {
        writer
            // tag$10
            .pack_as::<_, NBits<2>>(0b10)?
            // query_id:uint64
            .pack(self.query_id)?
            // amount:(VarUInteger 16)
            .pack_as::<_, &VarInt<4>>(&self.amount)?;
        Ok(())
    }
}

writer.pack(Hello {
    query_id: 0,
    amount: 1_000u64.into(),
})?;

Deserialization

To be able to deserialize a type from BitReader, we should implement BitUnpack on it:

impl BitUnpack for Hello {
    fn unpack<R>(mut reader: R) -> Result<Self, R::Error>
        where R: BitReader,
    {
        // tag$10
        let tag: u8 = reader.unpack_as::<_, NBits<2>>()?;
        if tag != 0b10 {
            return Err(Error::custom(format!("unknown tag: {tag:#b}")));
        }
        Ok(Self {
            // query_id:uint64
            query_id: reader.unpack()?,
            // amount:(VarUInteger 16)
            amount: reader.unpack_as::<_, VarInt<4>>()?,
        })
    }
}

let hello: Hello = parser.unpack()?;

Re-exports

pub use bitvec;

pub use either;

Modules

adapters

Adapters for BitReader / BitWriter

as

De/serialization helpers for TL-B.

de

Binary deserialization for TL-B

integer

Collection of de/serialization helpers for integers

ser

Binary serialization for TL-B

Structs

StringError

String-backed Error

Traits

Context

Adapter for providing context on Result

Error

De/serialization error