Skip to main content

Location

Struct Location 

Source
pub struct Location(/* private fields */);
Expand description

The identity/coordinate primitives — change id, epoch, location — are owned by tributary-proto and re-exported from there directly (tributary-fs merely re-exports them itself). The per-watch Interest is not among them: the umbrella owns its own source-neutral mask (aligned to EventKind), and the proto/fs Interest stays a purely fs-internal arm mask for consumers driving a raw fs watcher. A canonical location: the sequence of Segments from a watched root to a target.

An empty location denotes the watched root itself. The core reconstructs a location by walking the parent-relative watch tree, so a location is always rooted at a disjoint scope root rather than at the filesystem root.

Implementations§

Source§

impl Location

Source

pub const fn new() -> Location

An empty location (the watched root itself).

Source

pub fn from_segments(segments: impl IntoIterator<Item = Segment>) -> Location

Builds a location from a sequence of canonical segments.

Source

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

The segments as a slice, root-first.

Source

pub const fn len(&self) -> usize

The number of segments (the depth below the watched root).

Source

pub const fn is_empty(&self) -> bool

Whether this is the watched root itself (no segments).

Source

pub fn name(&self) -> Option<&Segment>

The final segment (the target’s own name), or None for the root.

Source

pub fn push(&mut self, segment: Segment)

Appends a child segment, descending one level.

Source

pub fn child(self, segment: Segment) -> Location

Returns this location with segment appended (builder form).

Source

pub fn join(self, suffix: &Location) -> Location

Returns this location extended with every segment of suffix, descending through it (builder form).

Source

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

Whether this location lies within prefix’s subtree — prefix names this location itself or one of its ancestors (prefix-inclusive: every location starts with itself, and everything starts with the empty root location).

Trait Implementations§

Source§

impl Clone for Location

Source§

fn clone(&self) -> Location

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 Location

Source§

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

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

impl Default for Location

Source§

fn default() -> Location

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

impl Eq for Location

Source§

impl FromIterator<Segment> for Location

Source§

fn from_iter<T>(iter: T) -> Location
where T: IntoIterator<Item = Segment>,

Creates a value from an iterator. Read more
Source§

impl Hash for Location

Source§

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

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

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Location

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Location

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Location

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> AutoreleaseSafe for T
where T: ?Sized,

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, 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.