Skip to main content

Addressing

Struct Addressing 

Source
pub struct Addressing<'a> {
    pub keyed_lists: &'a [KeyedList<'a>],
    pub array_rule: Option<ArrayRule<'a>>,
}
Expand description

How a non-numeric path segment resolves against an array.

A non-empty ASCII-decimal segment is always an index and never consults this (overflow is an error, not a slug fallback). Everything else has two possible sources, tried in this order:

  • keyed_lists — the caller’s own declarations, e.g. “the array at identities is keyed by each element’s identity field”. A JSON or TOML document does not say this about itself, so only the caller can, and it names one exact array by path.
  • array_rule — the format’s rule, for a format whose value is a tree afdata synthesized and therefore knows the shape of. Only Markdown has one today; it applies to every array in the document rather than to one named path.

With neither, a non-numeric segment against an array is DocumentError::UnregisteredArray — afdata will not scan an array it was told nothing about.

Fields§

§keyed_lists: &'a [KeyedList<'a>]§array_rule: Option<ArrayRule<'a>>

Implementations§

Source§

impl<'a> Addressing<'a>

Source

pub const INDEX_ONLY: Addressing<'static>

Indices only: no keyed lists, no format rule.

Source

pub const fn keyed(keyed_lists: &'a [KeyedList<'a>]) -> Self

Caller-declared keyed lists, with no format rule.

Source

pub const fn with_array_rule(self, array_rule: Option<ArrayRule<'a>>) -> Self

The same addressing plus a format’s built-in array rule.

Trait Implementations§

Source§

impl<'a> Clone for Addressing<'a>

Source§

fn clone(&self) -> Addressing<'a>

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<'a> Copy for Addressing<'a>

Source§

impl<'a> Debug for Addressing<'a>

Source§

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

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

impl<'a> Default for Addressing<'a>

Source§

fn default() -> Addressing<'a>

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

Auto Trait Implementations§

§

impl<'a> Freeze for Addressing<'a>

§

impl<'a> RefUnwindSafe for Addressing<'a>

§

impl<'a> Send for Addressing<'a>

§

impl<'a> Sync for Addressing<'a>

§

impl<'a> Unpin for Addressing<'a>

§

impl<'a> UnsafeUnpin for Addressing<'a>

§

impl<'a> UnwindSafe for Addressing<'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> 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more