Struct Import

pub struct Import { /* private fields */ }

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

Created through the import() function.

Implementations

impl Import

pub fn with_alias<A>(self, alias: A) -> Import

where A: Into<ItemStr>,

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>(self, alias: A) -> Import

where A: Into<ItemStr>,

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

Switch to a qualified import mode.

See ImportMode::Qualified.

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

pub fn direct(self) -> Import

Switch into a direct import mode.

See ImportMode::Direct.

Examples

use genco::prelude::*;

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

let toks = quote!($ty);

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

Trait Implementations

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

Formats the value using the given formatter.

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

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

Convert the type into tokens in-place.

impl FormatInto<Rust> for Import

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

Convert the type into tokens in-place.

impl From<Import> for Any

fn from(lang: Import) -> Any

Converts to this type from the input type.

impl Hash for Import

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

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

Format the language item appropriately.

impl Ord for Import

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Import

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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

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

Convert the type into tokens.

impl Register<Rust> for Import

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

Convert the type into tokens.

impl Eq for Import

impl StructuralPartialEq for Import