Struct StringKey 

pub struct StringKey(/* private fields */);

Default string-based record key

Supports both static (zero-cost) and interned (leaked) names. Use string literals for the common case; they auto-convert via From.

Memory Model

Dynamic keys are “interned” by leaking memory into 'static lifetime. This is optimal for AimDB’s use case where keys are:

• Registered once at startup
• Never deallocated during runtime
• Frequently cloned (now just pointer copy)

The tradeoff: memory for dynamic keys is never freed. This is acceptable because typical deployments have <100 keys totaling <4KB.

Naming Convention

Recommended format: <namespace>.<category>.<instance>

Examples:

• sensors.temperature.outdoor
• sensors.temperature.indoor
• mesh.weather.sf-bay
• config.app.settings
• tenant.acme.sensors.temp

Examples

use aimdb_core::record_id::StringKey;

// Static (preferred) - zero allocation
let key: StringKey = "sensors.temperature".into();

// Dynamic - for runtime-generated names
let key = StringKey::intern(format!("tenant.{}.sensors", "acme"));

Implementations

impl StringKey

pub const fn new(s: &'static str) -> Self

Create from a static string literal

This is a const fn, usable in const contexts.

pub fn intern(s: impl AsRef<str>) -> Self

Create from a runtime-generated string

Use this for dynamic names (multi-tenant, config-driven, etc.).

Memory

The string is leaked into 'static lifetime. This is intentional:

• Keys are registered once at startup
• Enables O(1) Copy/Clone
• Typical overhead: <4KB for 100 keys

Panics (debug builds only)

In debug builds with std feature, panics if more than 1000 keys are interned. This catches accidental misuse (e.g., creating keys in a loop). Production builds have no limit.

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

Create from a runtime string (alias for intern)

The string is leaked into 'static lifetime for O(1) cloning.

pub fn is_static(&self) -> bool

Returns true if this is a static (compile-time) key

pub fn is_interned(&self) -> bool

Returns true if this is an interned (runtime) key

Trait Implementations

impl AsRef<str> for StringKey

fn as_ref(&self) -> &str

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

impl Borrow<str> for StringKey

Enable O(1) HashMap lookup by &str

This allows hashmap.get("string_literal") without allocating a StringKey.

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for StringKey

fn clone(&self) -> StringKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StringKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StringKey

Available on crate feature std only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for StringKey

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

Formats the value using the given formatter.

impl From<&'static str> for StringKey

Ergonomic conversion from string literals

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl From<String> for StringKey

Available on crate feature std only.

Ergonomic conversion from owned String (std)

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for StringKey

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StringKey

fn cmp(&self, other: &Self) -> 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<&str> for StringKey

Enable direct comparison with &str reference

fn eq(&self, other: &&str) -> 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 PartialEq<str> for StringKey

Enable direct comparison with &str

fn eq(&self, other: &str) -> 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 PartialEq for StringKey

fn eq(&self, other: &Self) -> 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 StringKey

fn partial_cmp(&self, other: &Self) -> 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 RecordKey for StringKey

fn as_str(&self) -> &str

String representation for connectors, logging, serialization, remote access

fn link_address(&self) -> Option<&str>

Connector address for this key

impl Serialize for StringKey

Available on crate feature std only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for StringKey

impl Eq for StringKey