Skip to main content

PublishedPages

Struct PublishedPages 

Source
pub struct PublishedPages(/* private fields */);
Expand description

Where each source document is actually published: the file the site serves, keyed by the source markdown’s file name.

[rewrite_doc_link] used to derive a link’s target from the link’s own spelling — ../BUILD_PLAN_V2.md../BUILD_PLAN_V2.html — which is correct only while every document is served under its own stem. Site pages ended that: a page is published as its declared site-page: slug, and a slug is URL-safe by construction ([a-z0-9-]+), so docs/BUILD_PLAN_V2.md is served as build-plan-v2.html. The rewrite then pointed four correct repository links at a page that is never emitted — issue #446, live on roteiro.dev.

So the served name is looked up rather than guessed. The renderer is handed the index of what the site emits, which is the only thing that knows the answer.

Keyed by file name rather than by full path because the site mirrors the repository’s layout — docs/*.md at the root, docs/adr/*.md under adr/ — so a link’s directory hops are already correct and only the final segment can differ. A file name claimed by two published documents is recorded as ambiguous and left unrewritten: guessing which one a link meant is how a link silently points at the wrong page, which is worse than the 404 it replaces.

Implementations§

Source§

impl PublishedPages

Source

pub fn new() -> Self

An empty index: every .md link falls back to its own stem.

Source

pub fn publish(&mut self, source_file: &str, served_as: &str)

Record that source_file (a markdown file name, e.g. BUILD_PLAN_V2.md) is served as served_as (e.g. build-plan-v2.html).

A second, differing claim on one file name makes it ambiguous; see the type’s documentation for why that is left unrewritten.

Trait Implementations§

Source§

impl Clone for PublishedPages

Source§

fn clone(&self) -> PublishedPages

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PublishedPages

Source§

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

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

impl Default for PublishedPages

Source§

fn default() -> PublishedPages

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

impl Eq for PublishedPages

Source§

impl PartialEq for PublishedPages

Source§

fn eq(&self, other: &PublishedPages) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PublishedPages

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> 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.