Trait const_gen::CompileConst

pub trait CompileConst {
    fn const_type() -> String;
    fn const_val(&self) -> String;

    fn const_declaration(&self, name: &str) -> String { ... }
    fn const_definition(_attrs: &str) -> String { ... }
}

Trait which defines how a type should be represented as a constant

Required methods

fn const_type() -> String

Get a string representation of a type. This must be implemented for each type. Types with generics may need to be able to access an instance of one of its generic members and call this function in order to properly represent the type. Note that this is not necessarily a representation of the ACTUAL type, but rather the type that should be used if this data is going to be represented as a compile-time constant.

fn const_val(&self) -> String

Get a string representation of the current value in constant form. This method is where the real magic happens, but self.const_declaration() is likely the only one you need to call.

Loading content...

Provided methods

fn const_declaration(&self, name: &str) -> String

Takes a string (a SCREAMING_SNAKE_CASE string is preferred) to use as a constant name, then calls self.const_type() and self.const_val() in order to generate a Rust compile-time constant declaration statement.

fn const_definition(_attrs: &str) -> String

Return a const definition for this type. Attributes may be included, and must be formatted as the compiler would expect to see them (including the pound sign and square brackets "#[...]"). Always returns an empty string for types defined in the standard library. Typically this is easier to call instead through the const_definition! macro.

Loading content...

Implementations on Foreign Types

impl CompileConst for u8

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for u16

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for u32

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for u64

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for u128

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for usize

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for i8

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for i16

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for i32

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for i64

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for i128

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for isize

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for f32

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for f64

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for String

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for &str

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for str

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst> CompileConst for Vec<T>

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst> CompileConst for &[T]

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst> CompileConst for Box<T>

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst + Clone> CompileConst for Cow<'_, T>

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst> CompileConst for Rc<T>

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst> CompileConst for Arc<T>

fn const_type() -> String

fn const_val(&self) -> String

impl<K: CompileConst, V: CompileConst> CompileConst for HashMap<K, V>

fn const_type() -> String

fn const_val(&self) -> String

impl<E: CompileConst> CompileConst for HashSet<E>

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for ()

fn const_type() -> String

fn const_val(&self) -> String

impl<T: CompileConst, U: CompileConst> CompileConst for (T, U)

fn const_type() -> String

fn const_val(&self) -> String

impl<T, U, V> CompileConst for (T, U, V) where
    T: CompileConst,
    U: CompileConst,
    V: CompileConst, 

fn const_type() -> String

fn const_val(&self) -> String

impl<T, U, V, W> CompileConst for (T, U, V, W) where
    T: CompileConst,
    U: CompileConst,
    V: CompileConst,
    W: CompileConst, 

fn const_type() -> String

fn const_val(&self) -> String

impl<T, U, V, W, X> CompileConst for (T, U, V, W, X) where
    T: CompileConst,
    U: CompileConst,
    V: CompileConst,
    W: CompileConst,
    X: CompileConst, 

fn const_type() -> String

fn const_val(&self) -> String

impl<T, U, V, W, X, Y> CompileConst for (T, U, V, W, X, Y) where
    T: CompileConst,
    U: CompileConst,
    V: CompileConst,
    W: CompileConst,
    X: CompileConst,
    Y: CompileConst, 

fn const_type() -> String

fn const_val(&self) -> String

impl<T, U, V, W, X, Y, Z> CompileConst for (T, U, V, W, X, Y, Z) where
    T: CompileConst,
    U: CompileConst,
    V: CompileConst,
    W: CompileConst,
    X: CompileConst,
    Y: CompileConst,
    Z: CompileConst, 

fn const_type() -> String

fn const_val(&self) -> String

Loading content...

Implementors

Loading content...