Trait CompileConst

Source

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

    // Provided methods
    fn declaration(
        &self,
        attrs: &str,
        vis: &str,
        declaration_type: DeclarationType,
        name: &str,
    ) -> String { ... }
    fn const_declaration(&self, attrs: &str, vis: &str, name: &str) -> String { ... }
    fn static_declaration(&self, attrs: &str, vis: &str, name: &str) -> String { ... }
    fn const_definition(_attrs: &str, _vis: &str) -> String { ... }
}

Expand description

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

Required Methods§

Source

fn const_type() -> String

Get a string representation of a type. This must be implemented for each 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.

Source

fn const_val(&self) -> String

Get a string representation of the current value in constant form.

Provided Methods§

Source

fn declaration( &self, attrs: &str, vis: &str, declaration_type: DeclarationType, name: &str, ) -> String

Generates the declaration statement string.

Takes 3 strings: Attributes, a visibility (eg pub) and a name (a SCREAMING_SNAKE_CASE string is preferred), plus a declaration type (e.g. const or static).

It then constructs a valid Rust declaration statement using the type and value of the current object by calling const_val() and const_type().

 use const_gen::{CompileConst, DeclarationType};

 let test_str_declaration = "I'm a string!".declaration(
    "#[allow(dead_code)]",
    "pub(crate)",
    DeclarationType::Const,
    "TEST_STR",
 );
 assert_eq!(
    test_str_declaration,
    r#"#[allow(dead_code)] pub(crate) const TEST_STR: &str = "I'm a string!";"#
 );

Source

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

Generates the declaration statement string for a const declaration.

See declaration() for more information.

Source

fn static_declaration(&self, attrs: &str, vis: &str, name: &str) -> String

Generates the declaration statement string for a static declaration.

See declaration() for more information.

Source

fn const_definition(_attrs: &str, _vis: &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. Visibility modifiers (eg, pub(…)) may be used, or an empty string passed in to generate a private item.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait CompileConst Copy item path

Required Methods§

fn const_type() -> String

fn const_val(&self) -> String

Provided Methods§

fn declaration( &self, attrs: &str, vis: &str, declaration_type: DeclarationType, name: &str, ) -> String

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

fn static_declaration(&self, attrs: &str, vis: &str, name: &str) -> String

fn const_definition(_attrs: &str, _vis: &str) -> String

Dyn Compatibility§

Implementations on Foreign Types§

impl CompileConst for &str

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for IpAddr

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for SocketAddr

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for bool

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for char

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 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 str

fn const_type() -> String

fn const_val(&self) -> String

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 ()

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 String

fn const_type() -> String

fn const_val(&self) -> String

impl CompileConst for Ipv4Addr

fn const_type() -> String

fn const_val(&self) -> String

Trait CompileConst