Skip to main content

CodeIdGenerator

Struct CodeIdGenerator 

Source
pub struct CodeIdGenerator { /* private fields */ }
Expand description

ID generator for code:api profile

Implementations§

Source§

impl CodeIdGenerator

Source

pub fn new(namespace: impl Into<String>) -> Self

Create a new code ID generator

Source

pub fn module_id(&self, module_name: &str, docs: &str) -> ElementId

Generate module ID: namespace.module

Source

pub fn struct_id( &self, module_name: &str, struct_name: &str, docs: &str, ) -> ElementId

Generate struct ID: namespace.module.Struct

Source

pub fn method_id( &self, module_name: &str, struct_name: &str, method_name: &str, signature: &str, docs: &str, ) -> ElementId

Generate method ID: namespace.module.Struct.method

Source

pub fn function_id( &self, module_name: &str, function_name: &str, docs: &str, ) -> ElementId

Generate function ID: namespace.module.function

Source

pub fn enum_id( &self, module_name: &str, enum_name: &str, docs: &str, ) -> ElementId

Generate enum ID: namespace.module.Enum

Source

pub fn trait_id( &self, module_name: &str, trait_name: &str, docs: &str, ) -> ElementId

Generate trait ID: namespace.module.Trait

Auto Trait Implementations§

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> Same for T

Source§

type Output = T

Should always be Self
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.