Skip to main content

CrossRefResolve

Struct CrossRefResolve 

Source
pub struct CrossRefResolve {
    pub registry: NumberRegistry,
    pub target: String,
}
Expand description

Resolves Node::CrossRef nodes by looking up their target label in a NumberRegistry produced by crate::AutoNumber.

For the “web” target a CrossRef is replaced by a Node::Link whose url is #<target> and whose display text is e.g. "Figure 1".

For the “print” target the node is replaced by a plain Node::Text containing the same display text (page numbers would be added by a downstream typesetter).

If the target label is not found in the registry the CrossRef node is left in place unchanged so that downstream tools can handle it or report the error.

§Example

use rdx_transform::{AutoNumber, CrossRefResolve, Transform, parse};

let mut root = parse(
    "<Figure id=\"fig:arch\">\n</Figure>\n\
     See {@fig:arch}.\n",
);
let numberer = AutoNumber::new();
numberer.transform(&mut root, "");
let registry = numberer.registry().entries.clone();
let resolver = CrossRefResolve::new(
    rdx_transform::NumberRegistry { entries: registry },
    "web",
);
resolver.transform(&mut root, "");

Fields§

§registry: NumberRegistry§target: String

Output target: "web" or "print".

Implementations§

Source§

impl CrossRefResolve

Source

pub fn new(registry: NumberRegistry, target: impl Into<String>) -> Self

Trait Implementations§

Source§

impl Transform for CrossRefResolve

Source§

fn name(&self) -> &str

A short identifier for this transform (used in error messages / debugging).
Source§

fn transform(&self, root: &mut Root, _source: &str)

Apply the transform to the AST. source is the original document text, available for transforms that need to reference raw content.

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.