Struct krill::commons::eventsourcing::Key

pub struct Key { /* private fields */ }

Represents the key used in KVx. Consists of a scope of type Scope and a name of type SegmentBuf.

Implementations

impl Key

pub fn new_scoped(scope: Scope, name: impl Into<SegmentBuf>) -> Key

Create a Key from a Scope and a Segment.

Example

use kvx_types::{Key, Scope, Segment};

Key::new_scoped(Scope::global(), Segment::parse("keyname")?);

pub fn new_global(name: impl Into<SegmentBuf>) -> Key

Create a Key from a Segment.

Example

use kvx_types::{Key, Segment};

Key::new_global(Segment::parse("keyname")?);

pub fn name(&self) -> &Segment

Returns the name of a Key (without its scope).

pub fn scope(&self) -> &Scope

Returns the scope of a Key (without its name).

pub fn with_sub_scope(&self, sub_scope: impl Into<SegmentBuf>) -> Key

Create a new Key and add a Segment to the end of its scope.

pub fn add_sub_scope(&mut self, sub_scope: impl Into<SegmentBuf>)

Add a Segment to the end of the scope of the key.

pub fn with_super_scope(&self, super_scope: impl Into<SegmentBuf>) -> Key

Create a new Key and add a Segment to the front of its scope.

pub fn add_super_scope(&mut self, super_scope: impl Into<SegmentBuf>)

Add a Segment to the front of the scope of the key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&PendingTask> for Key

fn from(p: &PendingTask) -> Key

Converts to this type from the input type.

impl From<&RunningTask> for Key

fn from(p: &RunningTask) -> Key

Converts to this type from the input type.

impl FromStr for Key

type Err = ParseSegmentError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Key, <Key as FromStr>::Err>

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

impl Hash for Key

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

where __H: Hasher,

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 Key

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

Restrict a value to a certain interval.

impl PartialEq for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Key

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key