Struct GffPath 

pub struct GffPath { /* private fields */ }

An address into a GFF tree, such as ClassList[0].Class.

Rendering gives the same dot notation rakata-lint already prints in LintDiagnostic.fields, so a consumer wanting to navigate to a finding rather than display it has one address type to use for both.

Implementations

impl GffPath

pub fn new(segments: Vec<GffPathSegment>) -> Self

Creates a path from its segments.

pub fn segments(&self) -> &[GffPathSegment]

The steps this path takes, in order.

pub fn is_empty(&self) -> bool

Whether this path names nothing.

pub fn parent(&self) -> Option<Self>

This path with its last step dropped, or None when it has none.

What a list mutation records against: appending to or removing from a list changes the list, and the index the caller named is not where the change is once the siblings have shifted.

pub fn then(&self, segment: GffPathSegment) -> Self

Extends this path by one step, which is how a walk builds one.

pub fn starts_with(&self, prefix: &Self) -> bool

Whether prefix names this node or one of its ancestors.

Segment by segment rather than over the rendered text, and that is the whole reason this is a method. "ItemList".starts_with("ItemLis") is true and ItemList is not under ItemLis, so a prefix test written on the strings answers yes for a sibling whose label merely begins the same way. Comparing segments cannot make that mistake, because a label is matched whole.

Reflexive, matching the slice method it is built on: a path starts with itself. Callers wanting proper descendants exclude equality themselves, which is what the tree does when deciding whether a collapsed node hides a row, since a collapsed node has to keep drawing itself.

Ordering makes this cheap to use over a set. GffPath sorts by segments, so every descendant of a path sorts contiguously after it with nothing able to sort between; a BTreeMap of changes answers “anything under here” with one range and this test on the first entry.

Trait Implementations

impl Clone for GffPath

fn clone(&self) -> GffPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GffPath

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

Formats the value using the given formatter.

impl Default for GffPath

fn default() -> GffPath

Returns the “default value” for a type.

impl Display for GffPath

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

Formats the value using the given formatter.

impl From<&GffPath> for FieldRoute

fn from(path: &GffPath) -> Self

The route a path in one file takes through every file.

The inverse of FieldRoute::at, and lossy in the direction it has to be: Creature List[3].HitPoints becomes Creature List[].HitPoints, because which element was in hand is a fact about the file and a route carries only facts about the format.

Total, and there is nothing here that could fail. Every segment maps to exactly one step, so a path that addresses nothing at all still projects to the route it would have taken. Whether the schema declares anything there is the separate question FieldRoute::field_in answers, and keeping the two apart is what lets a caller ask about a node the file carries and no view models.

impl FromStr for GffPath

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

Parses dot notation with bracketed list indices.

PropertiesList[0].PropertyName is three segments: a field, an index, and a field.

type Err = GffPathParseError

The associated error which can be returned from parsing.

impl Hash for GffPath

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 Ord for GffPath

fn cmp(&self, other: &GffPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for GffPath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for GffPath

fn partial_cmp(&self, other: &GffPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for GffPath

impl StructuralPartialEq for GffPath