Trait Key 

pub trait Key:
    Sized
    + Ord
    + Clone
    + Debug
    + Default
    + Max
    + Min {
    const SERIALIZED_SIZE: usize;

    // Required methods
    fn write_to<W: Write>(&self, writer: &mut W) -> Result<usize>;
    fn read_from<R: Read>(reader: &mut R) -> Result<Self>;
    fn from_bytes(bytes: &[u8]) -> Result<Self>;
}

Trait defining requirements for keys used in the StaticBTree.

Keys must support ordering (Ord), cloning (Clone), debugging (Debug), and have a fixed serialized size (SERIALIZED_SIZE). Variable-length types like String must be adapted (e.g., using fixed-size prefixes) to conform.

Required Associated Constants

const SERIALIZED_SIZE: usize

The exact size of the key in bytes when serialized. This is crucial for calculating node sizes and offsets.

Required Methods

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

Serializes the key into the provided writer.

Arguments

• writer: The Write target.

Returns

Returns the number of bytes written, which is always SERIALIZED_SIZE Err(Error) if writing fails.

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

Deserializes a key from the provided reader.

Arguments

• reader: The Read source.

Returns

Ok(Self) containing the deserialized key on success. Err(Error) if reading fails or the implementation cannot read exactly SERIALIZED_SIZE bytes.

fn from_bytes(bytes: &[u8]) -> Result<Self>

Deserializes a key from the provided bytes.

Arguments

• bytes: The bytes to deserialize the key from.

Returns

Ok(Self) containing the deserialized key on success. Err(Error) if the bytes are not a valid key.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Key for DateTime<Utc>

const SERIALIZED_SIZE: usize = 12

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for bool

const SERIALIZED_SIZE: usize = 1

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for i8

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for i16

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for i32

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for i64

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for u8

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for u16

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for u32

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

impl Key for u64

const SERIALIZED_SIZE: usize

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

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

fn from_bytes(bytes: &[u8]) -> Result<Self>

Implementors

impl Key for OrderedFloat<f32>

const SERIALIZED_SIZE: usize

impl Key for OrderedFloat<f64>

const SERIALIZED_SIZE: usize

impl<const N: usize> Key for FixedStringKey<N>

const SERIALIZED_SIZE: usize = N