Struct LinkContext 

pub struct LinkContext {
    pub layout: Layout,
    pub book_root: String,
    pub markdown_root: String,
    pub entity_paths: HashMap<EntityRef, PathBuf>,
    pub render_from: Option<PathBuf>,
    /* private fields */
}

Entity output path index used by LinkFormatter.

Fields

layout: Layout

Active page layout (controls relative path shape).

book_root: String

mdBook project root used when resolving relative links.

markdown_root: String

Markdown output root relative to book_root.

entity_paths: HashMap<EntityRef, PathBuf>

Resolved output path for each entity in the current render pass.

render_from: Option<PathBuf>

Current page path used when formatting relative entity links.

Implementations

impl LinkContext

pub fn empty( layout: Layout, book_root: impl Into<String>, markdown_root: impl Into<String>, ) -> Self

Creates an empty context with layout and path roots but no entity entries.

pub fn from_manual(manual: &ReferenceManual, opts: &Options) -> Self

Builds a link context from a reference manual and render options.

pub fn register_stored_entity( &mut self, module: &str, group: &str, group_dir: &str, entity: &StoredEntity, is_protobuf: bool, layout: Layout, markdown_root: &str, )

Registers one stored entity in the path index.

pub fn layout_entity_keys(&self) -> impl Iterator<Item = &LayoutEntityKey>

Iterate layout entity keys registered in this context.

pub fn package_page_rel(&self, package: &str) -> PathBuf

Relative path to a package rollup page.

pub fn package_index_rel(&self, package: &str) -> PathBuf

Relative path to a package index page.

pub fn layout_entity_path( &self, package: &str, kind: ProtobufEntityKind, name: &str, ) -> Option<&PathBuf>

Lookup layout entity path.

pub fn entity_path(&self, entity_ref: &EntityRef) -> Option<&PathBuf>

Lookup entity path by EntityRef.

pub fn link_from( &self, from: &Path, package: &str, kind: ProtobufEntityKind, name: &str, ) -> String

Format a markdown link to an entity from from.

pub fn link_entity(&self, from: &Path, entity_ref: &EntityRef) -> String

Format a markdown link to a stored entity from from.

pub fn link_type(&self, from: &Path, fqn: &str) -> String

Format a markdown link for a protobuf FQN type reference.

pub fn summary_link(&self, from: &Path, target: &Path, title: &str) -> String

SUMMARY nav link from from to target.

Trait Implementations

impl Clone for LinkContext

fn clone(&self) -> LinkContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkContext

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

Formats the value using the given formatter.

impl Default for LinkContext

fn default() -> LinkContext

Returns the “default value” for a type.

impl Eq for LinkContext

impl PartialEq for LinkContext

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LinkContext