Struct tcgeneric::id::Id

pub struct Id { /* fields omitted */ }

A generic Id

Id is widely used within the Tinychain host software to identify individual variables within a transaction context as well as files and directories.

An Id must be valid UTF8 and must not contain whitespace or any control character sequence like {/, .., ~, $, \, ^, &, |, =, {, }, <, >, ', ", ?, :, @, #}.

Implementations

impl Id

pub fn as_str(&self) -> &str

Borrows the String underlying this Id.

pub fn starts_with(&self, prefix: &str) -> bool

Return true if this Id begins with the specified string.

Trait Implementations

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl Display for Id

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

Formats the value using the given formatter.

impl Eq for Id

impl Extend<Id> for TCPathBuf

fn extend<T: IntoIterator<Item = PathSegment>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Id> for TCPathBuf

fn from(segment: PathSegment) -> TCPathBuf

Performs the conversion.

impl From<Label> for Id

fn from(l: Label) -> Id

Performs the conversion.

impl From<Uuid> for Id

fn from(id: Uuid) -> Self

Performs the conversion.

impl From<u64> for Id

fn from(i: u64) -> Id

Performs the conversion.

impl From<usize> for Id

fn from(u: usize) -> Id

Performs the conversion.

impl FromIterator<Id> for TCPathBuf

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

Creates a value from an iterator.

impl FromStr for Id

type Err = TCError

The associated error which can be returned from parsing.

fn from_str(id: &str) -> TCResult<Id>

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

impl FromStream for Id

type Context = ()

The decoding context of this type, useful in situations where the stream to be decoded may be too large to hold in main memory.

fn from_stream<'life0, 'async_trait, D: Decoder>(
    _context: (),
    d: &'life0 mut D
) -> Pin<Box<dyn Future<Output = Result<Self, D::Error>> + Send + 'async_trait>> where
    D: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Parse this value using the given Decoder.

impl Hash for Id

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'en> IntoStream<'en> for Id

fn into_stream<E: Encoder<'en>>(self, e: E) -> Result<E::Ok, E::Error>

Take ownership of this value and serialize it into the given encoder.

impl Ord for Id

fn cmp(&self, other: &Id) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a str> for Id

fn eq(&self, other: &&'a str) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Id> for Id

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

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

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

This method tests for !=.

impl PartialEq<Label> for Id

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<str> for Id

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Id> for Id

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for Id

impl StructuralPartialEq for Id

impl<'en> ToStream<'en> for Id

fn to_stream<E: Encoder<'en>>(&'en self, e: E) -> Result<E::Ok, E::Error>

Serialize this value into the given encoder.

impl TryCastFrom<String> for Id

fn can_cast_from(id: &String) -> bool

Test if value can be cast into Self.

fn opt_cast_from(id: String) -> Option<Id>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

pub fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err> where
    OnErr: FnOnce(&T) -> Err, 

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.

impl TryCastFrom<TCPathBuf> for Id

fn can_cast_from(path: &TCPathBuf) -> bool

Test if value can be cast into Self.

fn opt_cast_from(path: TCPathBuf) -> Option<Id>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

pub fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err> where
    OnErr: FnOnce(&T) -> Err, 

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.