Enum bit_manager::data::StringConverter

pub enum StringConverter {
    LengthPrefixed {
        prefix_bits: u8,
    },
    NullTerminated,
    FixedLength {
        length: u32,
    },
}

An enum that allows the reading and writing of strings using various methods

Variants

LengthPrefixed

Prefixes the string with length.

This is the default option. The recommended number of bits for the prefix is 32.

Requires 2 bits to store converter for recommended number of bits, otherwise 7 bits to store

Fields of LengthPrefixed

prefix_bits: u8

The number of bits in the prefix

NullTerminated

Terminates the string with a null character (\0). The string must not contain a null character.

This option is recommended if it is possible to guarantee that the string will never contain a null character.

Requires 2 bits to store converter

FixedLength

Writes a string with a specified fixed length. If the string is shorter, it will have null characters (\0) appended until it is the right length.

This option is only recommended if it is known in advance how long the string will be.

Requires 34 bits to store converter

Fields of FixedLength

length: u32

The length of the string

Trait Implementations

impl Debug for StringConverter

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for StringConverter

fn default() -> Self

Returns the "default value" for a type.

impl BitStore for StringConverter

fn read_from<R: BitRead>(reader: &mut R) -> Result<Self>

Reads a value from the given reader.

fn write_to<W: BitWrite>(&self, writer: &mut W) -> Result<()>

Writes this value to the given writer.

impl BitConvert<String> for StringConverter

fn read_value_from<R: BitRead>(&self, reader: &mut R) -> Result<String>

Reads a value from the given reader.

fn write_value_to<W: BitWrite>(
    &self,
    value: &String,
    writer: &mut W
) -> Result<()>

Writes this value to the given writer.