Struct DocPath 

pub struct DocPath { /* private fields */ }

A canonical document-model path — an ordered DocSeg list with one Display serializer and one FromStr parser. See the module docs for the grammar.

Implementations

impl DocPath

pub fn new() -> Self

The empty base for a config-space / opaque-prefix path ($seed.<kind>, a Quill.yaml schema-literal owner label) — the one unrooted form, not a document-model address. A document-model path roots at main or card.

pub fn main() -> Self

The main-card root, main — the base every main-card address extends (main.title, main.recipients[0].name, main.body).

pub fn main_body() -> Self

The main body anchor, main.body.

pub fn card(kind: Option<&str>, index: usize) -> Self

A composable card root. kind: None is the unknown-kind whole-card form cards[<i>]; Some(k) is cards.<k>[<i>].

pub fn field(&self, name: &str) -> Self

This path extended by a field segment. The name is stored verbatim — callers pass validated field names, or a config-space prefix ($seed.<kind>) as an opaque head.

pub fn index(&self, index: usize) -> Self

This path extended by an array index segment.

pub fn body(&self) -> Self

This path extended by the terminal body segment.

pub fn segment(&self, seg: &PathSegment) -> Self

This path extended by a value-relative PathSegment — the bridge from the value-tree walk (!must_fill collection): Key becomes a field, Index an index.

pub fn segs(&self) -> &[DocSeg]

The segments, head first.

Trait Implementations

impl Clone for DocPath

fn clone(&self) -> DocPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocPath

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

Formats the value using the given formatter.

impl Default for DocPath

fn default() -> DocPath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocPath

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

The one document-model path serializer. A Field takes a leading . unless it heads the path; Index and Body never do; the card and main roots are self-contained heads.

impl Eq for DocPath

impl FromStr for DocPath

fn from_str(s: &str) -> Result<Self, Self::Err>

The inverse of Display, total over every emitted path. A main head is the main root — main.body the body, main alone the bare root, otherwise a main field chain; a cards-headed shape matching a card root becomes a Card; a trailing .body under a root is Body; an unrooted chain is a config-space anchor ($seed.<kind>).

type Err = DocPathParseError

The associated error which can be returned from parsing.

impl Hash for DocPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DocPath

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocPath