Struct Key 

pub struct Key { /* private fields */ }

Key represents a dictionary key with its string and metadata.

A key contains:

• A string (ptr + length)
• Either an ID or a weight (union)

Implementations

impl Key

pub fn new() -> Self

Creates a new empty key.

pub fn get(&self, i: usize) -> u8

Returns the character at the specified index.

Panics

Panics if index is out of bounds.

pub fn set_str(&mut self, s: &str)

Sets the key from a string slice.

pub fn set_bytes(&mut self, bytes: &[u8])

Sets the key from a byte slice.

pub fn set_id(&mut self, id: usize)

Sets the key ID.

pub fn set_weight(&mut self, weight: f32)

Sets the key weight.

pub fn as_bytes(&self) -> &[u8]

Returns the key as a byte slice.

Returns an empty slice if no string is set.

pub fn as_str(&self) -> &str

Returns the key string as a str reference.

Panics

Panics if the key contains invalid UTF-8.

pub fn ptr(&self) -> Option<*const u8>

Returns a pointer to the key data.

pub fn length(&self) -> usize

Returns the length of the key string.

pub fn id(&self) -> usize

Returns the key ID.

Safety

This accesses the union as an ID. The caller must ensure that set_id() was called more recently than set_weight().

pub fn weight(&self) -> f32

Returns the key weight.

Safety

This accesses the union as a weight. The caller must ensure that set_weight() was called more recently than set_id().

pub fn clear(&mut self)

Clears the key to empty state.

pub fn swap(&mut self, other: &mut Key)

Swaps with another key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Key

fn default() -> Self

Returns the “default value” for a type.

impl Send for Key

impl Sync for Key