pub struct Resolver<'a> {
pub env: &'a BuildEnvironment,
pub numfig: bool,
pub numfig_format: &'a BTreeMap<String, String>,
pub doctree: &'a dyn Fn(&str) -> Option<Cow<'a, Doctree>>,
pub relative_uri: &'a dyn Fn(&str, &str) -> String,
pub intersphinx: &'a Intersphinx,
}Expand description
Everything resolution reads: the environment, the numbering configuration, the other documents’ doctrees, and the builder’s URI policy.
Fields§
§env: &'a BuildEnvironment§numfig: bool§numfig_format: &'a BTreeMap<String, String>§doctree: &'a dyn Fn(&str) -> Option<Cow<'a, Doctree>>A document’s doctree, for :numref:’s target-node lookup
(env.get_doctree(docname).ids).
relative_uri: &'a dyn Fn(&str, &str) -> Stringbuilder.get_relative_uri(from, to).
intersphinx: &'a IntersphinxThe loaded cross-project inventories. An Intersphinx::default
(no mapping configured) makes every hook below inert, which is what
keeps a project without intersphinx_mapping byte-identical to what
it produced before this existed.
Implementations§
Source§impl Resolver<'_>
impl Resolver<'_>
Sourcepub fn resolve_xref(&self, req: &XrefRequest<'_>) -> XrefOutcome
pub fn resolve_xref(&self, req: &XrefRequest<'_>) -> XrefOutcome
StandardDomain.resolve_xref (:1034-1059) — the role → resolver
dispatch table.
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for Resolver<'a>
impl<'a> !Send for Resolver<'a>
impl<'a> !Sync for Resolver<'a>
impl<'a> !UnwindSafe for Resolver<'a>
impl<'a> Freeze for Resolver<'a>
impl<'a> Unpin for Resolver<'a>
impl<'a> UnsafeUnpin for Resolver<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more