WikiRenderer

Struct WikiRenderer 

Source
pub struct WikiRenderer;
Expand description

Renderer for wiki-style markdown output.

Implementations§

Source§

impl WikiRenderer

Source

pub const fn new() -> Self

Creates a new wiki renderer.

Source

pub fn render_index(&self, adrs: &[Adr], pages_url: Option<&str>) -> String

Generates the main ADR index page.

Source

pub fn render_by_status(&self, adrs: &[Adr]) -> String

Generates an ADR listing grouped by status.

Source

pub fn render_by_category(&self, adrs: &[Adr]) -> String

Generates an ADR listing grouped by category.

Source

pub fn render_timeline(&self, adrs: &[Adr]) -> String

Generates a chronological timeline of ADRs.

Source

pub fn render_statistics(&self, stats: &AdrStatistics) -> String

Generates a statistics summary page.

Source

pub fn render_all( &self, adrs: &[Adr], pages_url: Option<&str>, ) -> Result<Vec<(String, String)>>

Generates all wiki files.

Trait Implementations§

Source§

impl Clone for WikiRenderer

Source§

fn clone(&self) -> WikiRenderer

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 Debug for WikiRenderer

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for WikiRenderer

Source§

fn default() -> WikiRenderer

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