Trait Packable 

pub trait Packable:
    PartialEq
    + Debug
    + ToOwned<Owned: Debug + Clone + PartialEq>
    + PartialOrd {
    // Required methods
    fn width(item: &Self) -> usize;
    fn pack(item: &Self, out: &mut Vec<u8>);
    fn unpack(buff: &[u8]) -> Result<(usize, Cow<'_, Self>), PackError>;

    // Provided methods
    fn abs(_item: &Self) -> i64 { ... }
    fn agg(_item: &Self) -> Agg { ... }
    fn save(item: &Self) -> Vec<u8>  { ... }
    fn maybe_agg(_item: &Option<Cow<'_, Self>>) -> Agg { ... }
    fn validate<F>(val: Option<&Self>, validate: &F) -> Result<(), PackError>
       where F: Fn(Option<&Self>) -> Option<String> { ... }
}

Types that can be encoded into and decoded from the hexane columnar format.

Implemented for the primitive types used by the built-in cursors: u64, i64, u32, usize, bool, str, and [u8].

To use a custom type with RleCursor, implement Packable for it.

• pack / unpack: byte-level serialization (typically LEB128 for integers).
• width: the number of bytes pack will write, used for capacity estimation.
• agg: the per-item Agg aggregate (defaults to Agg::default() = no accumulation).
• abs: the “absolute” value for delta encoding (i64 only).

Required Methods

fn width(item: &Self) -> usize

fn pack(item: &Self, out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'_, Self>), PackError>

Provided Methods

fn abs(_item: &Self) -> i64

fn agg(_item: &Self) -> Agg

fn save(item: &Self) -> Vec<u8>

fn maybe_agg(_item: &Option<Cow<'_, Self>>) -> Agg

fn validate<F>(val: Option<&Self>, validate: &F) -> Result<(), PackError>

where F: Fn(Option<&Self>) -> Option<String>,

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Packable for bool

fn agg(item: &bool) -> Agg

fn width(_item: &bool) -> usize

fn pack(_item: &bool, _out: &mut Vec<u8>)

fn unpack(_buff: &[u8]) -> Result<(usize, Cow<'_, Self>), PackError>

impl Packable for i64

fn abs(item: &Self) -> i64

fn maybe_agg(item: &Option<Cow<'_, i64>>) -> Agg

fn width(item: &i64) -> usize

fn pack(item: &i64, out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'_, i64>), PackError>

impl Packable for str

fn width(item: &str) -> usize

fn pack(item: &str, out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'_, Self>), PackError>

impl Packable for u32

fn agg(item: &u32) -> Agg

fn width(item: &u32) -> usize

fn pack(item: &u32, out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'static, u32>), PackError>

impl Packable for u64

fn maybe_agg(item: &Option<Cow<'_, u64>>) -> Agg

fn agg(item: &u64) -> Agg

fn width(item: &u64) -> usize

fn pack(item: &u64, out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'static, u64>), PackError>

impl Packable for usize

fn width(item: &Self) -> usize

fn pack(item: &usize, out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'static, Self>), PackError>

impl Packable for [u8]

fn width(item: &[u8]) -> usize

fn pack(item: &[u8], out: &mut Vec<u8>)

fn unpack(buff: &[u8]) -> Result<(usize, Cow<'_, Self>), PackError>

Implementors