Skip to main content

PathPat

Struct PathPat 

Source
pub struct PathPat(pub Vec<SegPat>);
Expand description

A path pattern. Unlike a concrete Seg path it can reach every element of a sequence (SegPat::EachItem), every entry of a mapping (SegPat::AnyKey), or a whole subtree (SegPat::AnyDepth), so a rule can constrain each item of a list field (tags:, audience:) or everything beneath a key.

Tuple Fields§

§0: Vec<SegPat>

Implementations§

Source§

impl PathPat

Source

pub fn key(name: impl Into<String>) -> Self

A single top-level key — the common case (audience, title).

Source

pub fn each_item_of(name: impl Into<String>) -> Self

A top-level list field whose each item the rule governs (audience: as a sequence).

Source

pub fn subtree_of(name: impl Into<String>) -> Self

A top-level key and everything nested beneath it, the key itself included (meta, meta.author, meta.tags.0).

Source

pub fn matches(&self, path: &[Seg]) -> bool

Whether this pattern matches the concrete fig path. Without an SegPat::AnyDepth this is a segment-wise match of equal lengths; with one, the pattern may span any number of segments there.

Source

pub fn parse(text: &str) -> Result<PathPat, PatternError>

Read a pattern from the text the schema document format’s at holds: keys joined by ., * for any key, ** for any number of segments of any kind, [] for each item of a sequence, [0] for one index. The empty string is the root.

* and ** are whole segments — au* is the key au*, not a glob — and a segment is what is written: whitespace is not trimmed. The grammar has no quoting, as fig’s own parsePath has none, so a key containing . or [ cannot be addressed and a key literally named * cannot be addressed as a key. Both limits are inherited from fig and would be lifted by giving fig’s path grammar quoting first.

use fig_schema::{PathPat, SegPat};

assert_eq!(PathPat::parse("audience[]").unwrap(), PathPat::each_item_of("audience"));
assert_eq!(PathPat::parse("meta.**").unwrap(), PathPat::subtree_of("meta"));
assert_eq!(
    PathPat::parse("items[0].title").unwrap(),
    PathPat(vec![SegPat::Key("items".into()), SegPat::Index(0), SegPat::Key("title".into())]),
);
assert_eq!(PathPat::parse("").unwrap(), PathPat(vec![]));
assert!(PathPat::parse("a..b").is_err());
Source

pub fn concrete(&self) -> Option<Vec<Seg>>

This pattern as a concrete path, if it has no wildcard in it — what a command that takes a path from a person parses one with, since the grammar is the same and only *, ** and [] are refused.

use fig_schema::{PathPat, Seg};

let path = PathPat::parse("audience[1]").unwrap().concrete().unwrap();
assert_eq!(path, vec![Seg::Key("audience".into()), Seg::Index(1)]);
assert_eq!(PathPat::parse("audience[]").unwrap().concrete(), None);
Source

pub fn is_subsumed_by(&self, other: &PathPat) -> bool

Whether every path this pattern matches is also matched by other — so a rule at self listed after one at other can never govern anything. Sound but not complete: a true is always right, and a false may only mean the question was too hard, which for a lint is the right way round.

Trait Implementations§

Source§

impl Clone for PathPat

Source§

fn clone(&self) -> Self

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 Debug for PathPat

Source§

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

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

impl Display for PathPat

Source§

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

The pattern as PathPat::parse reads it — the inverse, so a rule’s at prints the way it was written.

Source§

impl Eq for PathPat

Source§

impl Hash for PathPat

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PathPat

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PathPat

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> 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, 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.