Crate tstr

source ·
Expand description

This crate provides an encoding of type-level strings as types.

§Examples

§Indexing

This example demonstrates how you can use type-level strings, and the Index trait, to access fields of generic types by name.

use std::ops::Index;

use tstr::{TS, ts};

fn main(){
    takes_person(&Person::new("Bob".into(), "Marley".into()));

    takes_person(&OtherPerson::new("Bob", "Marley"));
}

fn takes_person<P>(pers: &P)
where
    P: Index<TS!(name), Output = str> + Index<TS!(surname), Output = str>
{
    assert_eq!(&pers[ts!(name)], "Bob");
    assert_eq!(&pers[ts!(surname)], "Marley");
}


use person::Person;
mod person {
    use std::ops::Index;

    use tstr::TS;
     
    pub struct Person {
        name: String,
        surname: String,
    }
     
    impl Person {
        pub fn new(name: String, surname: String) -> Self {
            Self{name, surname}
        }
    }
     
    impl Index<TS!(name)> for Person {
        type Output = str;
         
        fn index(&self, _: TS!(name)) -> &str {
            &self.name
        }
    }
    
    impl Index<TS!(surname)> for Person {
        type Output = str;
         
        fn index(&self, _: TS!(surname)) -> &str {
            &self.surname
        }
    }
}

use other_person::OtherPerson;
mod other_person {
    use std::ops::Index;

    use tstr::TS;
     
    pub struct OtherPerson {
        name: &'static str,
        surname: &'static str,
    }
     
    impl OtherPerson {
        pub fn new(name: &'static str, surname: &'static str) -> Self {
            Self{name, surname}
        }
    }
     
    impl Index<TS!(name)> for OtherPerson {
        type Output = str;
         
        fn index(&self, _: TS!(name)) -> &str {
            self.name
        }
    }
    
    impl Index<TS!(surname)> for OtherPerson {
        type Output = str;
         
        fn index(&self, _: TS!(surname)) -> &str {
            self.surname
        }
    }
}

§Macro expansion

This library reserves the right to change how it represent type-level strings internally in every single release, and cargo feature combination.

This only affects you if you expand the code generated by macros from this crate, and then use that expanded code instead of going through the macros.

§Cargo features

  • "rust_1_46": Enables const functions in tstr::utils for comparing &str and &[u8].

  • "cmp_traits": Enables the traits for comparing type-level strings.

  • "use_syn": Changes how literals passed to the macros of this crate are parsed to use the syn crate. Use this if there is some literal that could not be parsed but is a valid str/integer literal.

  • "min_const_generics": changes the representation of type-level strings to use many char const parameter, making for better compiler errors for non-alphanumeric-ascii strings. Requires Rust 1.51.0.

  • "const_generics": Changes the representation of type-level strings to use a &'static str const parameter, making for better compiler errors, and a few more features. As of 2023-03-17, this feature can’t be enabled, because it requires &'static str to be stably usable as const parameters. Consider using "nightly_const_generics" if this feature can’t be used.

  • "nightly_const_generics": Equivalent to the "const_generics" feature, and enables the nightly compiler features to use &'static str const parameters.//!

  • "for_examples": Enables the for_examples module, with a few types used in documentation examples.

§No-std support

This crate is unconditionally #![no_std], and can be used anywhere that Rust can be.

§Minimum Supported Rust Version

This crate supports Rust versions back to Rust 1.40.0.

Re-exports§

  • pub use crate::asserts::Assert;

Modules§

  • asserts
    Types for asserting properties of type-level strings.
  • utils
    Utility functions

Macros§

  • TS
    The type of a type-level string, always a TStr.
  • alias
    Declares const and type aliases for type-level strings.
  • ts
    A type-level string TStr value.

Structs§

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

Traits§