Struct StateKey 

pub struct StateKey { /* private fields */ }

Fully qualified state-record key.

The namespace and namespace-local key are separate values. Keys are nonempty, contain at most 1024 UTF-8 bytes, and reject surrounding whitespace and control characters. A slash has no special storage meaning.

Examples

use storage_kit::state::record::StateKey;
let key = StateKey::new("workflow", "run/1")?;
assert_eq!(key.namespace().as_str(), "workflow");
assert_eq!(key.key(), "run/1");

Implementations

impl StateKey

pub fn new( namespace: impl Into<String>, key: impl Into<String>, ) -> Result<Self, StateStoreError>

Validates a namespace and key fragment.

Errors

Returns StateStoreError::InvalidRequest when the namespace exceeds 256 UTF-8 bytes or the key exceeds 1024, or either fragment is empty, has surrounding whitespace, or contains a control character.

Examples

use storage_kit::state::record::StateKey;
let key = StateKey::new("workflow", "run/1")?;
assert_eq!(key.key(), "run/1");
assert!(StateKey::new("workflow", "run/1\n").is_err());

pub fn namespace(&self) -> &StateNamespace

Returns the namespace.

Examples

use storage_kit::state::record::StateKey;
let key = StateKey::new("workflow", "run/1")?;
assert_eq!(key.namespace().as_str(), "workflow");

pub fn key(&self) -> &str

Returns the namespace-local key.

Examples

use storage_kit::state::record::StateKey;
let key = StateKey::new("workflow", "run/1")?;
assert_eq!(key.key(), "run/1");

Trait Implementations

impl Clone for StateKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateKey

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

Formats the value using the given formatter.

impl Eq for StateKey

impl Hash for StateKey

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 PartialEq for StateKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StateKey