Struct TreePath 

pub struct TreePath(/* private fields */);

A node, or a pattern of nodes, in the published tree.

Implementations

impl TreePath

pub const fn root() -> TreePath

The root of the tree: covers every workspace.

pub fn workspace(id: impl Into<String>) -> TreePath

pub fn push(self, level: Level, id: impl Into<String>) -> TreePath

Appends a named segment.

pub fn app(self, id: impl Into<String>) -> TreePath

pub fn kind(self, id: impl Into<String>) -> TreePath

pub fn resource(self, id: impl Into<String>) -> TreePath

pub fn item(self, id: impl Into<String>) -> TreePath

pub fn field(self, path: &str) -> TreePath

Appends a field path; dots separate nested fields.

pub fn action(self, id: impl Into<String>) -> TreePath

pub fn any(self, level: Level) -> TreePath

Appends “every node at this level”.

pub fn rest(self) -> TreePath

Appends “anywhere below”. A trailing rest adds nothing (a node already covers everything under it) and is dropped when the path is compared.

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

pub const fn is_root(&self) -> bool

pub fn within_workspace(&self) -> TreePath

This path without the workspace it starts at, if it starts at one: where it applies within its workspace.

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

The parent node, or None at the root.

pub fn id_at(&self, level: Level) -> Option<&str>

The first named id at level.

pub fn join(&self, rest: &TreePath) -> TreePath

self followed by every segment of rest.

pub fn joined(self, rest: &TreePath) -> TreePath

Self::join, taking self.

pub fn with_workspace(&self, from: &str, to: &str) -> TreePath

The same path with a leading workspace:<from> renamed to workspace:<to>.

pub fn workspace_id(&self) -> Option<&str>

pub fn covers(&self, path: &TreePath) -> bool

Whether self, read as a grant’s node, covers path: path is the node itself or lies below it.

pub fn overlaps(&self, other: &TreePath) -> bool

Whether some node lies at or below both self and other: a grant on one can decide an action under the other.

pub fn is_within(&self, ancestor: &TreePath) -> bool

Whether self lies at or below ancestor.

pub fn specificity(&self) -> Specificity

pub fn len(&self) -> usize

How many segments the path has.

pub fn is_empty(&self) -> bool

pub fn truncate(&mut self, len: usize)

Drops every segment after the first len: back to an ancestor a caller extended, to extend it again.

pub fn push_name(&mut self, level: Level, id: impl Into<String>)

Appends a named segment in place.

pub fn readable(&self) -> String

The path as a sentence reads it: the same text form, with each level named by what the code calls it (workspace:r/app:mail). Prose about a grant uses this; a path that is stored or sent uses the [Display] form, which keeps the names other builds read.

Trait Implementations

impl Clone for TreePath

fn clone(&self) -> TreePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreePath

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

Formats the value using the given formatter.

impl Default for TreePath

fn default() -> TreePath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TreePath

fn deserialize<D>( deserializer: D, ) -> Result<TreePath, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TreePath

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

The form a path is stored and sent in: room:r/app:mail/ kind:mail.message/resource:*/action:send, ** for any depth, / for the root. Ids escape % and / as %25 and %2F, and an id that is exactly * as %2A. TreePath::readable is the form a sentence reads.

impl FromStr for TreePath

type Err = PathError

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<TreePath, <TreePath as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for TreePath

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

where __H: Hasher,

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 TreePath

fn cmp(&self, other: &TreePath) -> 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 TreePath

fn eq(&self, other: &TreePath) -> 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 TreePath

fn partial_cmp(&self, other: &TreePath) -> 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 Serialize for TreePath

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TreePath

impl StructuralPartialEq for TreePath