Skip to main content

Path

Struct Path 

Source
pub struct Path { /* private fields */ }
Expand description

A path value used to locate objects in layers or scenegraphs.

Implementations§

Source§

impl Path

Source

pub const fn empty_path() -> Self

The empty path value.

Source

pub const fn absolute_root_path() -> Self

The absolute path representing the top of the namespace hierarchy.

Source

pub const fn reflexive_relative_path() -> Self

The relative path representing “self”.

Source

pub fn is_empty(&self) -> bool

Returns true if this path is the Path::empty_path.

Source

pub fn is_absolute_root(&self) -> bool

Returns true if this path is the Path::absolute_root_path.

Source

pub fn append_child(&self, child_name: &Token) -> Self

Creates a path by appending an element for child_name to this path.

This path must be a prim path, the AbsoluteRootPath or the ReflexiveRelativePath.

Source

pub fn append_property(&self, prop_name: &Token) -> Self

Creates a path by appending an element for prop_name to this path.

This path must be a prim path or the ReflexiveRelativePath.

Source

pub fn append_variant_selection(&self, variant_set: &str, variant: &str) -> Self

Creates a path by appending an element for variant_set and variant to this path.

This path must be a prim path.

Source

pub fn append_target(&self, target_path: &Path) -> Self

Creates a path by appending an element for target_path to this path.

This path must be a prim property or relational attribute path.

Source

pub fn append_relational_attribute(&self, attr_name: &Token) -> Self

Creates a path by appending an element for attr_name to this path.

This path must be a target path.

Source

pub fn append_mapper(&self, target_path: &Path) -> Self

Creates a path by appending an element for target_path to this path.

This path must be a prim property or relational attribute path.

Source

pub fn append_mapper_arg(&self, arg_name: &Token) -> Self

Creates a path by appending an element for arg_name to this path.

This path must be a mapper path.

Source

pub fn append_expression(&self) -> Self

Creates a path by appending an expression element to this path.

This path must be a prim property or relational attribute path.

Source

pub fn parent_path(&self) -> Self

Return the path that identifies this path’s namespace parent.

Source

pub fn name(&self) -> String

Trait Implementations§

Source§

impl Clone for Path

Source§

fn clone(&self) -> Path

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 Path

Source§

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

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

impl Default for Path

Source§

fn default() -> Self

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

impl Display for Path

Source§

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

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

impl Eq for Path

Source§

impl From<&str> for Path

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<Path> for Value

Source§

fn from(value: Path) -> Self

Converts to this type from the input type.
Source§

impl Hash for Path

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 Path

Source§

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

Source§

impl ValueType for Path

Source§

fn load(store: &ValueStore) -> Option<Self>

Source§

fn store(self) -> ValueStore

Auto Trait Implementations§

§

impl Freeze for Path

§

impl RefUnwindSafe for Path

§

impl Send for Path

§

impl Sync for Path

§

impl Unpin for Path

§

impl UnsafeUnpin for Path

§

impl UnwindSafe for Path

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, <T as TryFrom<U>>::Error>

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.