Struct PathRewrite 

pub struct PathRewrite {
    pub root: Option<String>,
    pub base: Option<String>,
    pub pages: BTreeMap<String, String>,
    pub attributes: Option<Vec<String>>,
}

html.pathRewrite: the URLs of a document’s attributes as a site serves them, as md.pathRewrite does for Markdown: relative ones resolved against the file’s path and made root-relative, every root-relative one under base, and links to a page’s file turned into its URL.

Fields

root: Option<String>

The directory URLs count from, as the file’s path spells it; the path’s own starting point when left out.

base: Option<String>

The URL the site is served at, such as /docs, put before every root-relative URL once.

pages: BTreeMap<String, String>

Files, relative to root, to the URL of their page, such as {"guide.html": "/guide/"}; an href naming one takes it.

attributes: Option<Vec<String>>

The attributes whose URLs are rewritten; href, src, srcset and poster when left out.

Trait Implementations

impl Clone for PathRewrite

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathRewrite

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

Formats the value using the given formatter.

impl Default for PathRewrite

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PathRewrite

where PathRewrite: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Plugin for PathRewrite

fn attach(&self, context: &mut Attach) -> Result<(), Error>

impl Transform for PathRewrite

fn input(&self) -> TreeKind

fn output(&self) -> TreeKind

fn run<'a>( &self, tree: Tree<'a>, file: &mut File, alloc: &'a Allocator, ) -> Result<Tree<'a>, Error>

fn start<'a>( &self, tree: Tree<'a>, file: &mut File, alloc: &'a Bump, ) -> Result<Step<'a>, Error>

Start the stage: a finished tree, or a job when its work is asynchronous.

fn host(&self) -> Option<u32>

The id of the binding function this stage stands for, which takes and returns whatever tree reaches it; None for a stage the crate runs.

fn html_writer(&self, _target: HtmlTarget) -> Option<Box<dyn HtmlWriter>>

Something that writes, from this stage’s input, the HTML a compiler aiming at target would write from its output, when the stage can skip building that tree.