Struct StateKey 

pub struct StateKey { /* private fields */ }

A state key built from its components. See the module docs.

Implementations

impl StateKey

pub fn pipeline(pipeline: impl Into<String>) -> Self

The pipeline-level key namespace of pipeline (no row yet).

pub fn invocation(pipeline: impl Into<String>, row: impl Into<String>) -> Self

{pipeline}::{row} — a matrix row’s (or topology sink node’s) key.

pub fn from_rendered(base: impl Into<String>) -> Self

A key derived from an invocation key render already produced — the base the per-invocation markers hang off.

pub fn with_tenant(self, tenant: Option<impl Into<String>>) -> Self

Place the key under tenant ({tenant}::{pipeline}::…, #709).

pub fn with_row(self, id: impl Into<String>) -> Self

The matrix row / topology node id.

pub fn with_parent_key(self, raw: impl Into<String>) -> Self

A child invocation’s parent-key value, raw; rendered through encode_component.

pub fn with_sub(self, encoded: impl Into<String>) -> Self

A sub-invocation component already in key form (a product tuple suffix).

pub fn with_shard(self, shard: impl Into<String>) -> Self

A shard of the invocation ({base}::{shard}).

pub fn with_suffix(self, suffix: KeySuffix) -> Self

A marker suffix.

pub fn tenant(&self) -> Option<&str>

The tenant, when the key is built from components.

pub fn pipeline_name(&self) -> Option<&str>

The pipeline name, when the key is built from components.

pub fn row(&self) -> Option<&str>

The row id, when the key is built from components.

pub fn sub(&self) -> Option<String>

The rendered sub-invocation component.

pub fn shard(&self) -> Option<&str>

The shard id.

pub fn suffix(&self) -> Option<&KeySuffix>

The marker suffix.

pub fn namespace(&self) -> String

[{tenant}::]{pipeline} — the first segments of every key of the pipeline; for a key built from a rendering, that rendering.

pub fn children_prefix(&self) -> String

The prefix every key under this one starts with ({key}::).

pub fn render(&self) -> String

The key under the current scheme.

pub fn render_scheme(&self, version: u32) -> String

The key as scheme version rendered it.

pub fn legacy_renderings(&self) -> Vec<String>

Every distinct, valid key an earlier scheme rendered for this key, newest scheme first — where migrate_state_key looks when the current key holds nothing.

pub fn parse(tenant: Option<&str>, pipeline: &str, key: &str) -> Option<Self>

Decode key under the namespace [{tenant}::]{pipeline}; None when it is outside it. A shard id cannot be told from a sub component, so it is returned as part of sub; the rendering round-trips.

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