Enum tynm::TypeName

pub enum TypeName<'s> {
    None,
    Array(TypeNameArray<'s>),
    Never,
    Pointer(TypeNamePointer<'s>),
    Reference(TypeNameReference<'s>),
    Slice(TypeNameSlice<'s>),
    Struct(TypeNameStruct<'s>),
    Tuple(TypeNameTuple<'s>),
    Unit,
}

Organizes type name string into distinct parts.

Variants

None

Array(TypeNameArray<'s>)

Never

Pointer(TypeNamePointer<'s>)

Reference(TypeNameReference<'s>)

Slice(TypeNameSlice<'s>)

Struct(TypeNameStruct<'s>)

Tuple(TypeNameTuple<'s>)

Unit

Methods

impl<'s> TypeName<'s>

pub fn new<T>() -> Self

Constructs a new TypeName with the name of T.

This is equivalent to calling std::any::type_name::<T>().into()

pub fn as_str(&self) -> String

Returns the type name string without any module paths.

This is equivalent to calling TypeName::as_str_mn(0, 0);

pub fn as_str_mn(&self, m: usize, n: usize) -> String

Returns the type name string with the given number of module segments.

If the left and right module segments overlap, the overlapping segments will only be printed printed once.

Parameters

• m: Number of module segments to include, beginning from the left (most significant).
• n: Number of module segments to include, beginning from the right (least significant).

pub fn as_display(&self) -> TypeNameDisplay

Returns an object that implements fmt::Display for printing the type name without any module paths directly with format! and {}.

When using this type name in a format! or similar it is more efficient to use this display instead of first creating a string.

Example

use tynm::TypeName;

let tn = TypeName::new::<String>();

println!("{}", tn.as_display());

pub fn as_display_mn(&self, m: usize, n: usize) -> TypeNameDisplay

Returns an object that implements fmt::Display for printing the type name without any module paths directly with format! and {}.

When using this type name in a format! or similar it is more efficient to use this display instead of first creating a string.

If the left and right module segments overlap, the overlapping segments will only be printed once.

Parameters

• buffer: Buffer to write to.
• m: Number of module segments to include, beginning from the left (most significant).
• n: Number of module segments to include, beginning from the right (least significant).

Example

use tynm::TypeName;

let tn = TypeName::new::<String>();

println!("{}", tn.as_display_mn(1, 2));

pub fn write_str<W>(
    &self,
    buffer: &mut W,
    m: usize,
    n: usize
) -> Result<(), Error> where
    W: Write, 

Writes the type name string to the given buffer.

If the left and right module segments overlap, the overlapping segments will only be printed once.

Parameters

• buffer: Buffer to write to.
• m: Number of module segments to include, beginning from the left (most significant).
• n: Number of module segments to include, beginning from the right (least significant).

Trait Implementations

impl<'s> Clone for TypeName<'s>

fn clone(&self) -> TypeName<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for TypeName<'s>

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

Formats the value using the given formatter.

impl<'s> Eq for TypeName<'s>

impl<'s> From<&'s str> for TypeName<'s>

fn from(std_type_name: &'s str) -> Self

Performs the conversion.

impl<'s> PartialEq<TypeName<'s>> for TypeName<'s>

fn eq(&self, other: &TypeName<'s>) -> bool

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

fn ne(&self, other: &TypeName<'s>) -> bool

This method tests for !=.

impl<'s> StructuralEq for TypeName<'s>

impl<'s> StructuralPartialEq for TypeName<'s>