Struct genco::lang::rust::Import

pub struct Import { /* fields omitted */ }

The import of a Rust name use std::collections::HashMap.

Created through the import() function.

Implementations

impl Import

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

Alias the given type as it's imported.

Examples

use genco::prelude::*;

let ty = rust::import("std::fmt", "Debug").with_alias("FmtDebug");

let toks = quote!(#ty);

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

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

Alias the module being imported.

This also implies that the import is qualified().

Examples

use genco::prelude::*;

let ty = rust::import("std::fmt", "Debug").with_module_alias("other");

let toks = quote!(#ty);

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

pub fn qualified(self) -> Self

Perform a qualified import by prefixing the module the type is being imported from.

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

This is implied if with_module_alias() is used.

Examples

use genco::prelude::*;

let ty = rust::import("std::fmt", "Debug").qualified();

let toks = quote!(#ty);

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

Trait Implementations

impl AsAny for Import

fn as_any(&self) -> Any

Coerce trait into an enum that can be used for type-specific operations.

impl Clone for Import

fn clone(&self) -> Import

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Import

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

Formats the value using the given formatter.

impl Eq for Import

impl FormatInto<Rust> for Import

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

Convert the type into tokens in-place.

impl<'a> FormatInto<Rust> for &'a Import

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

Convert the type into tokens in-place.

impl Hash for Import

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 Import

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

Format the language item appropriately.

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

Coerce into an imported type.

fn __lang_item_as_any(&self) -> &dyn Any

LangItem convert to Any. Automatically implemented by macro.

fn __lang_item_clone(&self) -> Box<dyn LangItem<Rust>>

LangItem clone. Automatically implemented by macro.

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

LangItem equality. Automatically implemented by macro.

impl Ord for Import

fn cmp(&self, other: &Import) -> 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<Import> for Import

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

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

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

This method tests for !=.

impl PartialOrd<Import> for Import

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

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

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

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

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

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

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

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

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

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

impl Register<Rust> for Import

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

Convert the type into tokens.

impl<'a> Register<Rust> for &'a Import

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

Convert the type into tokens.

impl StructuralEq for Import

impl StructuralPartialEq for Import