Struct Tag

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

A Tag that semantically characterises an event.

Tags are non-empty unicode strings in NFC representation (i.e. normalized by canonical decomposition followed by composition). Thus, ℌ and H are different tags while the various encodings of é are all represented by the codepoint E9.

Implementations

impl Tag

pub fn len(&self) -> usize

pub fn with_id(self, id: impl Into<String>) -> TagSet

Constructs an TagSet with <tag> and <tag>:<id>

Example

use ax_types::{TagSet, tags, tag};
let tags: TagSet = tag!("machine").with_id("Drill-404");
assert_eq!(tags, tags!("machine", "machine:Drill-404"));

Trait Implementations

impl Add<&Tag> for &TagSet

type Output = TagSet

The resulting type after applying the + operator.

fn add(self, rhs: &Tag) -> Self::Output

Performs the + operation.

impl Add<&Tag> for TagSet

type Output = TagSet

The resulting type after applying the + operator.

fn add(self, rhs: &Tag) -> Self::Output

Performs the + operation.

impl<T: Into<String>> Add<T> for Tag

Concatenate another part to this tag

let user_tag = tag!("user:") + "Bob";
let machine_tag = tag!("machine:") + format!("{}-{}", "thing", 42);

assert_eq!(user_tag, tag!("user:Bob"));
assert_eq!(machine_tag, tag!("machine:thing-42"));

This will never panic because the initial tag is already proven to be a valid tag.

type Output = Tag

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl Add<Tag> for &TagSet

type Output = TagSet

The resulting type after applying the + operator.

fn add(self, rhs: Tag) -> Self::Output

Performs the + operation.

impl Add<Tag> for TagSet

type Output = TagSet

The resulting type after applying the + operator.

fn add(self, rhs: Tag) -> Self::Output

Performs the + operation.

impl AddAssign<Tag> for TagSet

fn add_assign(&mut self, rhs: Tag)

Performs the += operation.

impl AsRef<str> for Tag

fn as_ref(&self) -> &str

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

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Decode<DagCborCodec> for Tag

fn decode<R: Read + Seek>(c: DagCborCodec, r: &mut R) -> Result<Self>

Decode from an impl Read.

impl<'de> Deserialize<'de> for Tag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tag

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

Formats the value using the given formatter.

impl Encode<DagCborCodec> for Tag

fn encode<W: Write>(&self, c: DagCborCodec, w: &mut W) -> Result<()>

Encodes into a impl Write.

impl FromIterator<Tag> for TagSet

fn from_iter<T: IntoIterator<Item = Tag>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Tag

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, ParseError>

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

impl Hash for Tag

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 Tag

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SubAssign<&Tag> for TagSet

fn sub_assign(&mut self, rhs: &Tag)

Performs the -= operation.

impl TryFrom<&str> for Tag

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, ParseError>

Performs the conversion.

impl TryFrom<Arc<str>> for Tag

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: Arc<str>) -> Result<Self, ParseError>

Performs the conversion.

impl Eq for Tag

impl StructuralPartialEq for Tag