Struct bevy_reflect::ParsedPath
source · pub struct ParsedPath(_);
Expand description
A pre-parsed path to an element within a type.
This struct may be used like GetPath
but removes the cost of parsing the path
string at each element access.
It’s recommended to use this in place of GetPath
when the path string is
unlikely to be changed and will be accessed repeatedly.
Implementations§
source§impl ParsedPath
impl ParsedPath
sourcepub fn parse(string: &str) -> Result<Self, ReflectPathError<'_>>
pub fn parse(string: &str) -> Result<Self, ReflectPathError<'_>>
Parses a ParsedPath
from a string.
Returns an error if the string does not represent a valid path to an element.
The exact format for path strings can be found in the documentation for GetPath
.
In short, though, a path consists of one or more chained accessor strings.
These are:
- Named field access (
.field
) - Unnamed field access (
.1
) - Field index access (
#0
) - Sequence access (
[2]
)
Example
#[derive(Reflect)]
struct Foo {
bar: Bar,
}
#[derive(Reflect)]
struct Bar {
baz: Baz,
}
#[derive(Reflect)]
struct Baz(f32, Vec<Option<u32>>);
let foo = Foo {
bar: Bar {
baz: Baz(3.14, vec![None, None, Some(123)])
},
};
let parsed_path = ParsedPath::parse("bar#0.1[2].0").unwrap();
// Breakdown:
// "bar" - Access struct field named "bar"
// "#0" - Access struct field at index 0
// ".1" - Access tuple struct field at index 1
// "[2]" - Access list element at index 2
// ".0" - Access tuple variant field at index 0
assert_eq!(parsed_path.element::<u32>(&foo).unwrap(), &123);
sourcepub fn reflect_element<'r, 'p>(
&'p self,
root: &'r dyn Reflect
) -> Result<&'r dyn Reflect, ReflectPathError<'p>>
pub fn reflect_element<'r, 'p>( &'p self, root: &'r dyn Reflect ) -> Result<&'r dyn Reflect, ReflectPathError<'p>>
Gets a read-only reference to the specified element on the given Reflect
object.
Returns an error if the path is invalid for the provided type.
See element_mut
for a typed version of this method.
sourcepub fn reflect_element_mut<'r, 'p>(
&'p mut self,
root: &'r mut dyn Reflect
) -> Result<&'r mut dyn Reflect, ReflectPathError<'p>>
pub fn reflect_element_mut<'r, 'p>( &'p mut self, root: &'r mut dyn Reflect ) -> Result<&'r mut dyn Reflect, ReflectPathError<'p>>
Gets a mutable reference to the specified element on the given Reflect
object.
Returns an error if the path is invalid for the provided type.
See element_mut
for a typed version of this method.
sourcepub fn element<'r, 'p, T: Reflect>(
&'p self,
root: &'r dyn Reflect
) -> Result<&'r T, ReflectPathError<'p>>
pub fn element<'r, 'p, T: Reflect>( &'p self, root: &'r dyn Reflect ) -> Result<&'r T, ReflectPathError<'p>>
Gets a typed, read-only reference to the specified element on the given Reflect
object.
Returns an error if the path is invalid for the provided type.
See reflect_element
for an untyped version of this method.
sourcepub fn element_mut<'r, 'p, T: Reflect>(
&'p mut self,
root: &'r mut dyn Reflect
) -> Result<&'r mut T, ReflectPathError<'p>>
pub fn element_mut<'r, 'p, T: Reflect>( &'p mut self, root: &'r mut dyn Reflect ) -> Result<&'r mut T, ReflectPathError<'p>>
Gets a typed, read-only reference to the specified element on the given Reflect
object.
Returns an error if the path is invalid for the provided type.
See reflect_element_mut
for an untyped version of this method.
Trait Implementations§
source§impl Clone for ParsedPath
impl Clone for ParsedPath
source§fn clone(&self) -> ParsedPath
fn clone(&self) -> ParsedPath
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ParsedPath
impl Debug for ParsedPath
source§impl Display for ParsedPath
impl Display for ParsedPath
source§impl Hash for ParsedPath
impl Hash for ParsedPath
source§impl Ord for ParsedPath
impl Ord for ParsedPath
source§fn cmp(&self, other: &ParsedPath) -> Ordering
fn cmp(&self, other: &ParsedPath) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<ParsedPath> for ParsedPath
impl PartialEq<ParsedPath> for ParsedPath
source§fn eq(&self, other: &ParsedPath) -> bool
fn eq(&self, other: &ParsedPath) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ParsedPath> for ParsedPath
impl PartialOrd<ParsedPath> for ParsedPath
source§fn partial_cmp(&self, other: &ParsedPath) -> Option<Ordering>
fn partial_cmp(&self, other: &ParsedPath) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moreimpl Eq for ParsedPath
impl StructuralEq for ParsedPath
impl StructuralPartialEq for ParsedPath
Auto Trait Implementations§
impl RefUnwindSafe for ParsedPath
impl Send for ParsedPath
impl Sync for ParsedPath
impl Unpin for ParsedPath
impl UnwindSafe for ParsedPath
Blanket Implementations§
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
source§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.