Struct deno_doc::html::GenerateCtx

source · 
pub struct GenerateCtx<'ctx> {
    pub package_name: Option<String>,
    pub common_ancestor: Option<PathBuf>,
    pub main_entrypoint: Option<ModuleSpecifier>,
    pub specifiers: Vec<ModuleSpecifier>,
    pub hbs: Handlebars<'ctx>,
    pub tree_sitter_highlighter: TreeSitterHighlighter,
    pub global_symbols: NamespacedGlobalSymbols,
    pub href_resolver: Rc<dyn HrefResolver>,
    pub rewrite_map: Option<IndexMap<ModuleSpecifier, String>>,
    pub hide_module_doc_title: bool,
    pub single_file_mode: bool,
    pub sidebar_flatten_namespaces: bool,
}

Fields§

§package_name: Option<String>§common_ancestor: Option<PathBuf>§main_entrypoint: Option<ModuleSpecifier>§specifiers: Vec<ModuleSpecifier>§hbs: Handlebars<'ctx>§tree_sitter_highlighter: TreeSitterHighlighter§global_symbols: NamespacedGlobalSymbols§href_resolver: Rc<dyn HrefResolver>§rewrite_map: Option<IndexMap<ModuleSpecifier, String>>§hide_module_doc_title: bool§single_file_mode: bool§sidebar_flatten_namespaces: bool

Implementations§

source§

impl<'ctx> GenerateCtx<'ctx>

source

pub fn url_to_short_path(&self, url: &ModuleSpecifier) -> String

Auto Trait Implementations§

§

impl<'ctx> !RefUnwindSafe for GenerateCtx<'ctx>

§

impl<'ctx> !Send for GenerateCtx<'ctx>

§

impl<'ctx> !Sync for GenerateCtx<'ctx>

§

impl<'ctx> Unpin for GenerateCtx<'ctx>

§

impl<'ctx> !UnwindSafe for GenerateCtx<'ctx>

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.

§

impl<T> Instrument for T

§

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

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

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 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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

§

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
§

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 T
where T: ?Sized,

§

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