Struct StateKey 

pub struct StateKey { /* private fields */ }

A key into the state bag, with the scope its prefix names.

Parsed once, at the edge, so everything downstream holds a key whose scope is already decided.

Implementations

impl StateKey

pub const MAX_LEN: usize = 128

Longest a key may be, prefix included. Keys are rendered into every request, and a key long enough to matter is a value wearing the wrong shape.

pub fn scoped(scope: StateScope, name: &str) -> Result<Self, StateKeyError>

Build a key from a scope and the name a store filed it under.

The other way round from FromStr: a store keeps the scope in its own column and the name without its prefix, so reading one back has both halves already and nothing to parse.

pub fn scope(&self) -> StateScope

The scope this key is stored in.

pub fn name(&self) -> &str

The key without its scope prefix, which is what a store files it under.

Trait Implementations

impl Clone for StateKey

fn clone(&self) -> StateKey

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

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

The key as written and as read back, prefix included.

impl Eq for StateKey

impl FromStr for StateKey

type Err = StateKeyError

The associated error which can be returned from parsing.

fn from_str(raw: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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

fn cmp(&self, other: &StateKey) -> 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 StateKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StateKey

fn partial_cmp(&self, other: &StateKey) -> 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 StructuralPartialEq for StateKey