Skip to main content

ResolutionContext

Struct ResolutionContext 

Source
#[non_exhaustive]
pub struct ResolutionContext<'a> { pub target: &'a str, pub provided_text: Option<&'a str>, }
Expand description

Describes a single cross-reference that needs to be resolved.

This carries only information the crate itself knows about the reference. A multi-document host that needs to know which document a reference originates from binds that “from” context when it constructs its ReferenceResolver, rather than receiving it here — keeping this seam free of any host-specific coordinate system.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§target: &'a str

The raw, uninterpreted cross-reference target, exactly as written in the source (e.g. "section-id", a reftext, or "other-page.adoc#frag").

§provided_text: Option<&'a str>

Explicit link text supplied in the cross-reference, if any.

Auto Trait Implementations§

§

impl<'a> Freeze for ResolutionContext<'a>

§

impl<'a> RefUnwindSafe for ResolutionContext<'a>

§

impl<'a> Send for ResolutionContext<'a>

§

impl<'a> Sync for ResolutionContext<'a>

§

impl<'a> Unpin for ResolutionContext<'a>

§

impl<'a> UnsafeUnpin for ResolutionContext<'a>

§

impl<'a> UnwindSafe for ResolutionContext<'a>

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> 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, 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.