Struct bevy_reflect::ParsedPath
source · pub struct ParsedPath(pub Vec<OffsetAccess>);
Expand description
A pre-parsed path to an element within a type.
This struct can be constructed manually from its Access
es or with
the parse method.
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.
§Examples
Parsing a &'static str
:
let my_static_string: &'static str = "bar#0.1[2].0";
// 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
let my_path = ParsedPath::parse_static(my_static_string);
Parsing a non-static &str
:
let my_string = String::from("bar#0.1[2].0");
// 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
let my_path = ParsedPath::parse(&my_string);
Manually constructing a ParsedPath
:
let path_elements = [
Access::Field(Cow::Borrowed("bar")),
Access::FieldIndex(0),
Access::TupleIndex(1),
Access::ListIndex(2),
Access::TupleIndex(1),
];
let my_path = ParsedPath::from(path_elements);
Tuple Fields§
§0: Vec<OffsetAccess>
This is a vector of pre-parsed OffsetAccess
es.
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 parse_static(string: &'static str) -> Result<Self, ReflectPathError<'_>>
pub fn parse_static(string: &'static str) -> Result<Self, ReflectPathError<'_>>
Similar to Self::parse
but only works on &'static str
and does not allocate per named field.
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<const N: usize> From<[OffsetAccess; N]> for ParsedPath
impl<const N: usize> From<[OffsetAccess; N]> for ParsedPath
source§fn from(value: [OffsetAccess; N]) -> Self
fn from(value: [OffsetAccess; N]) -> Self
source§impl From<Vec<OffsetAccess>> for ParsedPath
impl From<Vec<OffsetAccess>> for ParsedPath
source§fn from(value: Vec<OffsetAccess>) -> Self
fn from(value: Vec<OffsetAccess>) -> Self
source§impl Hash for ParsedPath
impl Hash for ParsedPath
source§impl Index<usize> for ParsedPath
impl Index<usize> for ParsedPath
source§impl IndexMut<usize> for ParsedPath
impl IndexMut<usize> 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 for ParsedPath
impl PartialEq 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 for ParsedPath
impl PartialOrd 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 moresource§impl<'a> ReflectPath<'a> for &'a ParsedPath
impl<'a> ReflectPath<'a> for &'a ParsedPath
source§fn reflect_element(
self,
root: &dyn Reflect
) -> Result<&dyn Reflect, ReflectPathError<'a>>
fn reflect_element( self, root: &dyn Reflect ) -> Result<&dyn Reflect, ReflectPathError<'a>>
source§fn reflect_element_mut(
self,
root: &mut dyn Reflect
) -> Result<&mut dyn Reflect, ReflectPathError<'a>>
fn reflect_element_mut( self, root: &mut dyn Reflect ) -> Result<&mut dyn Reflect, ReflectPathError<'a>>
source§fn element_mut<T: Reflect>(
self,
root: &mut dyn Reflect
) -> Result<&mut T, ReflectPathError<'a>>
fn element_mut<T: Reflect>( self, root: &mut dyn Reflect ) -> Result<&mut T, ReflectPathError<'a>>
impl Eq for ParsedPath
impl StructuralPartialEq for ParsedPath
Auto Trait Implementations§
impl Freeze for ParsedPath
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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.