lilliput-core 0.1.0

Low-level implementation of encoding/decoding logic for lilliput format
Documentation
use crate::{
    error::Result,
    header::{CompactStringHeader, ExtendedStringHeader, StringHeader},
    io::Write,
    num::WithPackedBeBytes as _,
    value::StringValue,
};

use super::Encoder;

impl<W> Encoder<W>
where
    W: Write,
{
    // MARK: - Value

    /// Encodes a string value, from a reference.
    pub fn encode_str(&mut self, value: &str) -> Result<()> {
        self.encode_string_header(&self.header_for_str_len(value.len()))?;

        // Push the value's actual bytes:
        self.push_bytes(value.as_bytes())?;

        Ok(())
    }

    /// Encodes a string value, from a `StringValue`.
    pub fn encode_string_value(&mut self, value: &StringValue) -> Result<()> {
        self.encode_str(&value.0)?;

        Ok(())
    }

    // MARK: - Header

    /// Enodes a string value's header.
    pub fn encode_string_header(&mut self, header: &StringHeader) -> Result<()> {
        let mut byte = StringHeader::TYPE_BITS;

        match *header {
            StringHeader::Compact(CompactStringHeader { len }) => {
                byte |= StringHeader::COMPACT_VARIANT_BIT;
                byte |= len & StringHeader::COMPACT_LEN_BITS;

                // Push the value's header:
                self.push_byte(byte)
            }
            StringHeader::Extended(ExtendedStringHeader { len }) => {
                len.with_packed_be_bytes(self.config.lengths.packing, |bytes| {
                    let width = bytes.len() as u8;

                    byte |= (width - 1) & StringHeader::EXTENDED_LEN_WIDTH_BITS;

                    #[cfg(feature = "tracing")]
                    tracing::debug!(
                        byte = crate::binary::fmt_byte(byte),
                        bytes = format!("{:b}", crate::binary::BytesSlice(bytes)),
                        len = len
                    );

                    // Push the value's header:
                    self.push_byte(byte)?;

                    // Push the value's length:
                    self.push_bytes(bytes)
                })
            }
        }
    }

    /// Creates a header for a string value, from its length.
    pub fn header_for_str_len(&self, len: usize) -> StringHeader {
        StringHeader::for_len(len, self.config.lengths.packing)
    }
}