Struct DocPackageBuilder 

pub struct DocPackageBuilder<'a> {
    stub_info: &'a StubInfo,
    export_resolver: ExportResolver<'a>,
    export_map: BTreeMap<String, String>,
    default_module_name: String,
}

Builder for converting StubInfo to DocPackage

Fields

stub_info: &'a StubInfo

export_resolver: ExportResolver<'a>

export_map: BTreeMap<String, String>

default_module_name: String

Implementations

impl<'a> DocPackageBuilder<'a>

pub fn new(stub_info: &'a StubInfo) -> Self

fn create_context<'b>(&'b self, module: &'b str) -> DocBuildContext<'b>

Create a build context for a specific module

pub fn build(self) -> Result<DocPackage>

fn build_module(&self, name: &str, module: &Module) -> Result<DocModule>

fn build_function( &self, module: &str, func_defs: &[FunctionDef], ) -> Result<DocItem>

fn build_signature_from_params( &self, module: &str, parameters: &Parameters, return_type: &TypeInfo, ) -> Result<DocSignature>

fn build_signature( &self, module: &str, def: &FunctionDef, ) -> Result<DocSignature>

fn build_signature_from_method( &self, module: &str, def: &MethodDef, ) -> Result<DocSignature>

fn build_type_alias( &self, module: &str, alias: &TypeAliasDef, ) -> Result<DocItem>

fn build_class(&self, module: &str, class: &ClassDef) -> Result<DocItem>

fn build_enum_as_class( &self, _module: &str, enum_def: &EnumDef, ) -> Result<DocItem>

fn build_variable(&self, module: &str, var: &VariableDef) -> Result<DocItem>

fn build_reexported_item( &self, source_module_name: &str, source_module: &Module, item_name: &str, ) -> Result<Option<DocItem>>

Build a re-exported item from a source module

fn correct_link_targets(&self, item: &mut DocItem, _target_module: &str)

Correct link targets in a re-exported item to point to the target module

fn correct_type_expr(&self, type_expr: &mut DocTypeExpr)

Correct a type expression to use export_map for link targets

fn strip_internal_module_prefix(&self, display: &str) -> String

Strip internal module prefixes (modules starting with ‘_’) from display text e.g., “_core.A” -> “A”, “_internal.Foo” -> “Foo”