Struct tstr::TStr

pub struct TStr<T>(_);

A type-level string type, similar to a &'static str const parameter.

Examples

Accessing Fields

This example demonstrates how you can use TStr to implement a generic accessor trait.

use tstr::TStr;
use tstr::{TS, ts};

fn main() {
    let mut tup = (3, 5, 8);
     
    assert_eq!(tup.get(ts!(0)), &3);
    assert_eq!(tup.get(ts!(1)), &5);
    assert_eq!(tup.get(ts!(2)), &8);

    let old_0 = replace(&mut tup, ts!(0), 333);
    let old_1 = replace(&mut tup, ts!(1), 555);
    let old_2 = replace(&mut tup, ts!(2), 888);
     
    assert_eq!(tup.get(ts!(0)), &333);
    assert_eq!(tup.get(ts!(1)), &555);
    assert_eq!(tup.get(ts!(2)), &888);

    assert_eq!(old_0, 3);
    assert_eq!(old_1, 5);
    assert_eq!(old_2, 8);
     
}

fn replace<T, N>(this: &mut T, name: TStr<N>, replacement: T::Field) -> T::Field
where
    T: Access<TStr<N>>,
    T::Field: Clone,
{
    let ret = this.get(name).clone();
    this.set(name, replacement);
    ret
}


trait Access<N> {
    type Field;

    fn get(&self, _field_name: N) -> &Self::Field;
    fn set(&mut self, _field_name: N, val: Self::Field);
}

impl<A, B, C> Access<TS!(0)> for (A, B, C) {
    type Field = A;

    fn get(&self, _field_name: TS!(0)) -> &A {
        &self.0
    }
    fn set(&mut self, _field_name: TS!(0), val: A){
        self.0 = val;
    }
}

impl<A, B, C> Access<TS!(1)> for (A, B, C) {
    type Field = B;

    fn get(&self, _field_name: TS!(1)) -> &B {
        &self.1
    }
    fn set(&mut self, _field_name: TS!(1), val: B){
        self.1 = val;
    }
}

impl<A, B, C> Access<TS!(2)> for (A, B, C) {
    type Field = C;

    fn get(&self, _field_name: TS!(2)) -> &C {
        &self.2
    }
    fn set(&mut self, _field_name: TS!(2), val: C){
        self.2 = val;
    }
}

Implementations

impl<T> TStr<T>

pub const NEW: Self

Constructs the TStr.

Example

use tstr::{TS, TStr};

type FOO = TS!(foo);

let foo_1: FOO = TStr::NEW;
let foo_2 = FOO::NEW; // The same as the previous statement

impl<T> TStr<T> where
    Self: StrValue, 

pub const STR: &'static str

This is supported on crate feature const_generics only.

The &'static str value of this TStr.

Example

use tstr::TS;

type FOO = TS!(foo);
type BAR = TS!(bar);

assert_eq!(FOO::STR, "foo");
assert_eq!(BAR::STR, "bar");

Trait Implementations

impl<T> Clone for TStr<T>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for TStr<T>

impl<T> Debug for TStr<T>

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

Formats the value using the given formatter.

impl<T> Default for TStr<T>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T> Eq for TStr<T>

impl Index<TStr<___<"bar">>> for Foo

This is supported on crate feature for_examples only.

type Output = u32

The returned type after indexing.

pub fn index(&self, _: TStr<___<bar>>) -> &u32

Performs the indexing (container[index]) operation.

impl Index<TStr<___<"bar">>> for Bar

This is supported on crate feature for_examples only.

type Output = u32

The returned type after indexing.

pub fn index(&self, _: TStr<___<bar>>) -> &u32

Performs the indexing (container[index]) operation.

impl Index<TStr<___<"baz">>> for Foo

This is supported on crate feature for_examples only.

type Output = u64

The returned type after indexing.

pub fn index(&self, _: TStr<___<baz>>) -> &u64

Performs the indexing (container[index]) operation.

impl Index<TStr<___<"baz">>> for Bar

This is supported on crate feature for_examples only.

type Output = bool

The returned type after indexing.

pub fn index(&self, _: TStr<___<baz>>) -> &bool

Performs the indexing (container[index]) operation.

impl Index<TStr<___<"boom">>> for Bar

This is supported on crate feature for_examples only.

type Output = Option<char>

The returned type after indexing.

pub fn index(&self, _: TStr<___<boom>>) -> &Option<char>

Performs the indexing (container[index]) operation.

impl Index<TStr<___<"qux">>> for Foo

This is supported on crate feature for_examples only.

type Output = &'static str

The returned type after indexing.

pub fn index(&self, _: TStr<___<qux>>) -> &&'static str

Performs the indexing (container[index]) operation.

impl IndexMut<TStr<___<"bar">>> for Foo

This is supported on crate feature for_examples only.

pub fn index_mut(&mut self, _: TStr<___<bar>>) -> &mut u32

Performs the mutable indexing (container[index]) operation.

impl IndexMut<TStr<___<"bar">>> for Bar

This is supported on crate feature for_examples only.

pub fn index_mut(&mut self, _: TStr<___<bar>>) -> &mut u32

Performs the mutable indexing (container[index]) operation.

impl IndexMut<TStr<___<"baz">>> for Foo

This is supported on crate feature for_examples only.

pub fn index_mut(&mut self, _: TStr<___<baz>>) -> &mut u64

Performs the mutable indexing (container[index]) operation.

impl IndexMut<TStr<___<"baz">>> for Bar

This is supported on crate feature for_examples only.

pub fn index_mut(&mut self, _: TStr<___<baz>>) -> &mut bool

Performs the mutable indexing (container[index]) operation.

impl IndexMut<TStr<___<"boom">>> for Bar

This is supported on crate feature for_examples only.

pub fn index_mut(&mut self, _: TStr<___<boom>>) -> &mut Option<char>

Performs the mutable indexing (container[index]) operation.

impl IndexMut<TStr<___<"qux">>> for Foo

This is supported on crate feature for_examples only.

pub fn index_mut(&mut self, _: TStr<___<qux>>) -> &mut &'static str

Performs the mutable indexing (container[index]) operation.

impl<T> MakeTStr for TStr<T>

pub const MAKE: Self

Gets a value of this type

impl<T> Ord for TStr<T>

pub fn cmp(&self, _other: &Self) -> 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<T> PartialEq<TStr<T>> for TStr<T>

pub fn eq(&self, _other: &Self) -> 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<T> PartialOrd<TStr<T>> for TStr<T>

pub fn partial_cmp(&self, _other: &Self) -> 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<const S: &'static str> StrValue for TStr<___<S>>

This is supported on crate feature const_generics only.

pub const STR: &'static str

The &'static str value of this TStr.

pub fn to_str(self) -> &'static str

Gets the &'static str value of this TStr.

impl<T> ToUint for TStr<T> where
    T: ToUint, 

pub const U128: u128

The u128 value of the type.

pub const DIGITS: u32

pub const USIZE: usize

The usize value of the type.

pub fn to_usize(&self) -> usize

Gets the usize value of this type

pub fn to_u128(&self) -> u128

Gets the u128 value of this type