Skip to main content

HtmlGenerator

Struct HtmlGenerator 

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

HTML 生成器

Implementations§

Source§

impl HtmlGenerator

Source

pub fn new() -> Self

创建新的 HtmlGenerator

使用默认配置创建 HTML 生成器

Source

pub fn with_config_and_theme(config: Config, theme_name: &str) -> Self

使用指定配置和主题名称创建 HtmlGenerator

§参数
  • config - 文档配置
  • theme_name - 主题名称
Source

pub fn with_config(config: Config) -> Self

使用指定配置创建 HtmlGenerator(使用默认主题)

§参数
  • config - 文档配置
Source

pub fn switch_theme(&mut self, theme_name: &str) -> Result<(), Box<dyn Error>>

切换主题

§参数
  • theme_name - 新的主题名称
Source

pub fn current_theme_name(&self) -> &str

获取当前主题名称

Source

pub fn available_themes() -> Vec<&'static str>

获取可用主题列表

Source

pub fn generate(&self, content: &str, title: &str) -> String

生成 HTML 文档

§参数
  • content - Markdown 渲染后的 HTML 内容
  • title - 页面标题
§返回值

返回完整的 HTML 页面字符串

Source

pub fn generate_with_context( &self, context: &PageContext, ) -> Result<String, Box<dyn Error>>

使用完整上下文生成 HTML 文档

§参数
  • context - 页面上下文
§返回值

返回完整的 HTML 页面字符串

Source

pub fn static_resources(&self) -> Vec<(String, String)>

获取主题的静态资源

Trait Implementations§

Source§

impl Clone for HtmlGenerator

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for HtmlGenerator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

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 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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