Struct genco::prelude::rust::Type

pub struct Type { /* fields omitted */ }

An imported name in Rust.

Implementations

impl Type

pub fn alias<A: Into<ItemStr>>(self, alias: A) -> Self

Alias the given type as it's imported.

Examples

use genco::prelude::*;

let ty = rust::imported("std::fmt", "Debug").alias("FmtDebug");

let toks = quote!(#ty);

assert_eq!(
    vec![
        "use std::fmt::Debug as FmtDebug;",
        "",
        "FmtDebug",
    ],
    toks.to_file_vec().unwrap()
);

pub fn module_alias<A: Into<ItemStr>>(self, alias: A) -> Type

Alias the module being imported.

This also implies that the import is [prefixed()].

Examples

use genco::prelude::*;

let ty = rust::imported("std::fmt", "Debug").module_alias("other");

let toks = quote!(#ty);

assert_eq!(
    vec![
        "use std::fmt as other;",
        "",
        "other::Debug",
    ],
    toks.to_file_vec().unwrap()
);

pub fn prefixed(self) -> Type

Prefix any use of this type with the corresponding module.

So importing std::fmt::Debug will cause the module to be referenced as fmt::Debug instead of Debug.

This is implied if [module_alias()] is used.

Examples

use genco::prelude::*;

let ty = rust::imported("std::fmt", "Debug").prefixed();

let toks = quote!(#ty);

assert_eq!(
    vec![
        "use std::fmt;",
        "",
        "fmt::Debug",
    ],
    toks.to_file_vec().unwrap()
);

pub fn with_arguments(self, args: impl Args) -> Type

Add generic arguments to the type.

Examples

use genco::prelude::*;

let ty = rust::imported("std::collections", "HashMap")
    .with_arguments((rust::local("u32"), rust::local("u32")));

let toks = quote!(#ty);

assert_eq!(
    vec![
        "use std::collections::HashMap;",
        "",
        "HashMap<u32, u32>",
    ],
    toks.to_file_vec().unwrap()
);

use genco::prelude::*;

let dbg = rust::imported("std::collections", "HashMap")
    .prefixed()
    .with_arguments((rust::local("T"), rust::local("U")));

let toks = quote!(#dbg);

assert_eq!(
    vec![
       "use std::collections;",
       "",
       "collections::HashMap<T, U>",
    ],
    toks.to_file_vec().unwrap()
);

pub fn reference<R: Into<Reference>>(self, reference: R) -> Self

Convert into a reference &<type> type.

pub fn into_dyn(self) -> Self

Convert into a dynamic dyn <type> type.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Eq for Type

impl FormatTokens<Rust> for Type

fn format_tokens(self, tokens: &mut Tokens<Rust>)

Convert the type into tokens.

fn into_tokens(self) -> Tokens<L> where
    Self: Sized, 

Convert into tokens.

fn is_empty(&self) -> bool

Hint to test if we are empty.

impl<'a> FormatTokens<Rust> for &'a Type

fn format_tokens(self, tokens: &mut Tokens<Rust>)

Convert the type into tokens.

fn into_tokens(self) -> Tokens<L> where
    Self: Sized, 

Convert into tokens.

fn is_empty(&self) -> bool

Hint to test if we are empty.

impl<'a> From<&'a Type> for LangBox<Rust>

fn from(value: &'a Type) -> Self

Performs the conversion.

impl From<Type> for LangBox<Rust>

fn from(value: Type) -> Self

Performs the conversion.

impl Hash for Type

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl LangItem<Rust> for Type

fn format(
    &self,
    out: &mut Formatter,
    config: &mut Config,
    level: usize
) -> Result

Format the language item appropriately.

fn as_import(&self) -> Option<&Self>

Coerce into an imported type.

fn eq(&self, other: &dyn LangItem<Rust>) -> bool

Check equality.

fn as_any(&self) -> &dyn Any

Convert into any type.

impl Ord for Type

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<Type> for Type

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

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

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

This method tests for !=.

impl PartialOrd<Type> for Type

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

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

fn lt(&self, other: &Type) -> bool

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

fn le(&self, other: &Type) -> bool

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

fn gt(&self, other: &Type) -> bool

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

fn ge(&self, other: &Type) -> bool

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

impl StructuralEq for Type

impl StructuralPartialEq for Type