Struct deno_doc::DocParser

source ·
pub struct DocParser<'a> {
    pub graph: ModuleGraph,
    pub private: bool,
    pub parser: CapturingModuleParser<'a>,
}

Fields§

§graph: ModuleGraph§private: bool§parser: CapturingModuleParser<'a>

Implementations§

source§

impl<'a> DocParser<'a>

source

pub fn new( graph: ModuleGraph, private: bool, parser: CapturingModuleParser<'a> ) -> Self

source

pub fn parse_module( &self, specifier: &ModuleSpecifier ) -> Result<ModuleDoc, DocError>

Parses a module into a list of exported items, as well as a list of reexported items which need to be fetched from other modules.

source

pub fn parse( &self, specifier: &ModuleSpecifier ) -> Result<Vec<DocNode>, DocError>

Fetches file_name and returns a list of exported items (no reexports).

source

pub fn parse_with_reexports( &self, specifier: &ModuleSpecifier ) -> Result<Vec<DocNode>, DocError>

Fetches file_name, parses it, and resolves its reexports.

source

pub fn get_doc_nodes_for_module_exports( &self, parsed_source: &ParsedSource, module_decl: &ModuleDecl, previous_doc_nodes: Vec<&DocNode> ) -> Vec<DocNode>

source

pub fn get_doc_node_for_decl( &self, parsed_source: &ParsedSource, decl: &Decl, previous_nodes: Vec<&DocNode> ) -> Option<Vec<DocNode>>

source

pub fn get_reexports_for_module_body( &self, module_body: &[ModuleItem] ) -> Vec<Reexport>

source

pub fn get_doc_nodes_for_module_body( &self, parsed_source: &ParsedSource, module_body: Vec<ModuleItem> ) -> Vec<DocNode>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for DocParser<'a>

§

impl<'a> !Send for DocParser<'a>

§

impl<'a> !Sync for DocParser<'a>

§

impl<'a> Unpin for DocParser<'a>

§

impl<'a> !UnwindSafe for DocParser<'a>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

const: unstable · 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, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> Send for Twhere T: ?Sized,

§

impl<T> Sync for Twhere T: ?Sized,