Struct VectorKey 

pub struct VectorKey { /* private fields */ }

A variable-size key type that stores data on the heap.

VectorKey is a heap-allocated key type that can store keys of any size. It’s ideal for scenarios where key sizes are not known at compile time or when keys can be very large.

Features

• Variable size: Can store keys of any length
• Heap allocated: Uses heap memory for storage
• Null termination: Automatically adds null termination for string keys
• Efficient: Uses Box<[u8]> for minimal memory overhead

Examples

use rart::keys::vector_key::VectorKey;

// Create from string (adds null terminator)
let key1: VectorKey = "hello world".into();

// Create from numeric types
let key2: VectorKey = 42u64.into();

// Create from long strings
let long_string = "a".repeat(1000);
let key3: VectorKey = long_string.into();

When to Use

Use VectorKey when:

• Key sizes are unknown at compile time
• Keys can be very large (> 32 bytes)
• You need maximum flexibility

Use ArrayKey when:

• Key sizes are bounded and known
• You want optimal performance
• Keys are relatively small (< 32 bytes)

Implementations

impl VectorKey

pub fn new_from_string(s: &String) -> Self

pub fn new_from_str(s: &str) -> Self

pub fn new_from_vec(data: Vec<u8>) -> Self

pub fn to_be_u64(&self) -> u64

Trait Implementations

impl AsRef<[u8]> for VectorKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VectorKey

fn clone(&self) -> VectorKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<&String> for VectorKey

fn from(data: &String) -> Self

Converts to this type from the input type.

impl From<&i128> for VectorKey

fn from(val: &i128) -> Self

Converts to this type from the input type.

impl From<&i16> for VectorKey

fn from(val: &i16) -> Self

Converts to this type from the input type.

impl From<&i32> for VectorKey

fn from(val: &i32) -> Self

Converts to this type from the input type.

impl From<&i64> for VectorKey

fn from(val: &i64) -> Self

Converts to this type from the input type.

impl From<&isize> for VectorKey

fn from(val: &isize) -> Self

Converts to this type from the input type.

impl From<&str> for VectorKey

fn from(data: &str) -> Self

Converts to this type from the input type.

impl From<&u128> for VectorKey

fn from(data: &u128) -> Self

Converts to this type from the input type.

impl From<&u16> for VectorKey

fn from(data: &u16) -> Self

Converts to this type from the input type.

impl From<&u32> for VectorKey

fn from(data: &u32) -> Self

Converts to this type from the input type.

impl From<&u64> for VectorKey

fn from(data: &u64) -> Self

Converts to this type from the input type.

impl From<&u8> for VectorKey

fn from(data: &u8) -> Self

Converts to this type from the input type.

impl From<&usize> for VectorKey

fn from(data: &usize) -> Self

Converts to this type from the input type.

impl From<String> for VectorKey

fn from(data: String) -> Self

Converts to this type from the input type.

impl From<VectorKey> for VectorPartial

fn from(value: VectorKey) -> Self

Converts to this type from the input type.

impl From<i128> for VectorKey

fn from(val: i128) -> Self

Converts to this type from the input type.

impl From<i16> for VectorKey

fn from(val: i16) -> Self

Converts to this type from the input type.

impl From<i32> for VectorKey

fn from(val: i32) -> Self

Converts to this type from the input type.

impl From<i64> for VectorKey

fn from(val: i64) -> Self

Converts to this type from the input type.

impl From<i8> for VectorKey

fn from(val: i8) -> Self

Converts to this type from the input type.

impl From<isize> for VectorKey

fn from(val: isize) -> Self

Converts to this type from the input type.

impl From<u128> for VectorKey

fn from(data: u128) -> Self

Converts to this type from the input type.

impl From<u16> for VectorKey

fn from(data: u16) -> Self

Converts to this type from the input type.

impl From<u32> for VectorKey

fn from(data: u32) -> Self

Converts to this type from the input type.

impl From<u64> for VectorKey

fn from(data: u64) -> Self

Converts to this type from the input type.

impl From<u8> for VectorKey

fn from(data: u8) -> Self

Converts to this type from the input type.

impl From<usize> for VectorKey

fn from(data: usize) -> Self

Converts to this type from the input type.

impl KeyTrait for VectorKey

const MAXIMUM_SIZE: Option<usize> = None

Maximum size of this key type, if any.

type PartialType = VectorPartial

The partial type associated with this key type.

fn extend_from_partial(&self, partial: &Self::PartialType) -> Self

Extend this key with bytes from a partial.

fn truncate(&self, at_depth: usize) -> Self

Truncate this key to the specified depth.

fn new_from_slice(data: &[u8]) -> Self

Create a new key from a byte slice.

fn at(&self, pos: usize) -> u8

Get the byte at the specified position.

fn length_at(&self, at_depth: usize) -> usize

Get the length of the key starting from the specified depth.

fn to_partial(&self, at_depth: usize) -> VectorPartial

Convert part of this key to a partial starting from the specified depth.

fn matches_slice(&self, slice: &[u8]) -> bool

Check if this key matches the given byte slice exactly.

fn new_from_partial(partial: &Self::PartialType) -> Self

Create a new key from a partial.

impl Ord for VectorKey

fn cmp(&self, other: &VectorKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VectorKey

fn eq(&self, other: &VectorKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VectorKey

fn partial_cmp(&self, other: &VectorKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for VectorKey

impl StructuralPartialEq for VectorKey