TypeRenderer

Struct TypeRenderer 

Source
pub struct TypeRenderer<'a> {
    link_resolver: &'a LinkResolver<'a>,
    current_module: &'a str,
}
Expand description

Renderer for type expressions

Fields§

§link_resolver: &'a LinkResolver<'a>§current_module: &'a str

Implementations§

Source§

impl<'a> TypeRenderer<'a>

Source

pub fn new(link_resolver: &'a LinkResolver<'a>, current_module: &'a str) -> Self

Source

pub fn render_type(&self, type_info: &TypeInfo) -> DocTypeExpr

Render a type expression

  1. Check if this is a type alias - preserve name, don’t expand
  2. Strip module prefixes from display text
  3. Resolve link target using LinkResolver
  4. Recursively handle generic parameters
Source

fn render_type_structure( &self, structure: &TypeStructure, type_info: &TypeInfo, ) -> DocTypeExpr

Recursively render a TypeStructure into a DocTypeExpr

Try to create a link target for a simple type name Uses type_refs to look up module information

Source

fn strip_module_prefix(&self, type_name: &str) -> String

Strip module prefixes from type names Remove “typing.”, “builtins.”, “package.submod.” Keep only bare names: “Optional[ClassA]” not “typing.Optional[sub_mod.ClassA]”

Auto Trait Implementations§

§

impl<'a> Freeze for TypeRenderer<'a>

§

impl<'a> RefUnwindSafe for TypeRenderer<'a>

§

impl<'a> Send for TypeRenderer<'a>

§

impl<'a> Sync for TypeRenderer<'a>

§

impl<'a> Unpin for TypeRenderer<'a>

§

impl<'a> UnwindSafe for TypeRenderer<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,