Struct EntityPath

Source

pub struct EntityPath { /* private fields */ }

Expand description

The unique identifier of an entity, e.g. camera/3/points

The entity path is a list of parts separated by slashes. Each part is a non-empty string, that can contain any character. When written as a string, some characters in the parts need to be escaped with a \ (only character, numbers, ., -, _ does not need escaping).

See https://www.rerun.io/docs/concepts/logging-and-ingestion/entity-path for more on entity paths.

This is basically implemented as a list of strings, but is reference-counted internally, so it is cheap to clone. It also has a precomputed hash and implemented nohash_hasher::IsEnabled, so it is very cheap to use in a nohash_hasher::IntMap and nohash_hasher::IntSet.

assert_eq!(
    EntityPath::parse_strict(r#"camera/ACME\ Örnöga/points/42"#).unwrap(),
    EntityPath::new(vec![
        "camera".into(),
        "ACME Örnöga".into(),
        "points".into(),
        "42".into(),
    ])
);

Struct EntityPath Copy item path

Implementations§

impl EntityPath

pub fn root() -> EntityPath

pub fn properties() -> EntityPath

pub fn is_reserved(&self) -> bool

pub fn new(parts: Vec<EntityPathPart>) -> EntityPath

pub fn from_file_path_as_single_string(file_path: &Path) -> EntityPath

pub fn from_file_path(file_path: &Path) -> EntityPath

pub fn ui_string(&self) -> String

pub fn from_single_string(string: impl Into<InternedString>) -> EntityPath

pub fn iter(&self) -> impl DoubleEndedIterator + ExactSizeIterator

pub fn last(&self) -> Option<&EntityPathPart>

pub fn as_slice(&self) -> &[EntityPathPart]

pub fn to_vec(&self) -> Vec<EntityPathPart>

pub fn is_root(&self) -> bool

pub fn is_property(&self) -> bool

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

pub fn strip_prefix(&self, prefix: &EntityPath) -> Option<EntityPath>

pub fn is_descendant_of(&self, other: &EntityPath) -> bool

pub fn is_child_of(&self, other: &EntityPath) -> bool

pub fn len(&self) -> usize

pub fn hash(&self) -> EntityPathHash

pub fn hash64(&self) -> u64

pub fn calculate_deterministic_hash(&self) -> u64

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

pub fn join(&self, other: &EntityPath) -> EntityPath

pub fn incremental_walk<'a>( start: Option<&EntityPath>, end: &'a EntityPath, ) -> impl Iterator<Item = EntityPath> + 'a + use<'a>

pub fn common_ancestor(&self, other: &EntityPath) -> EntityPath

pub fn common_ancestor_of<'a>( entities: impl Iterator<Item = &'a EntityPath>, ) -> EntityPath

pub fn short_names_with_disambiguation( entities: impl IntoIterator<Item = EntityPath>, ) -> HashMap<EntityPath, String, RandomState>

impl EntityPath

§Entity path parsing

pub fn parse_strict(input: &str) -> Result<EntityPath, PathParseError>

pub fn parse_forgiving(input: &str) -> EntityPath

Trait Implementations§

impl Clone for EntityPath

fn clone(&self) -> EntityPath

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

impl DataUi for EntityPath

fn data_ui(&self, ctx: &StoreViewContext<'_>, ui: &mut Ui, ui_layout: UiLayout)

impl Debug for EntityPath

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

impl<'de> Deserialize<'de> for EntityPath

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

impl Display for EntityPath

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

impl Div<&'static str> for &EntityPath

type Output = EntityPath

fn div(self, other: &'static str) -> <&EntityPath as Div<&'static str>>::Output

impl Div<&'static str> for EntityPath

type Output = EntityPath

fn div(self, other: &'static str) -> <EntityPath as Div<&'static str>>::Output

impl Div<EntityPathPart> for &EntityPath

type Output = EntityPath

fn div( self, other: EntityPathPart, ) -> <&EntityPath as Div<EntityPathPart>>::Output

impl Div<EntityPathPart> for EntityPath

type Output = EntityPath

fn div( self, other: EntityPathPart, ) -> <EntityPath as Div<EntityPathPart>>::Output

impl Div for &EntityPath

type Output = EntityPath

fn div(self, other: &EntityPath) -> <&EntityPath as Div>::Output

impl Div for EntityPath

type Output = EntityPath

fn div(self, other: EntityPath) -> <EntityPath as Div>::Output

impl From<&[EntityPathPart]> for EntityPath

fn from(path: &[EntityPathPart]) -> EntityPath

impl<'a> From<&'a EntityPath> for Cow<'a, EntityPath>

fn from(value: &'a EntityPath) -> Cow<'a, EntityPath>

impl From<&EntityPath> for EntityPath

fn from(value: &EntityPath) -> EntityPath

impl From<&str> for EntityPath

fn from(path: &str) -> EntityPath

impl<'a> From<EntityPath> for Cow<'a, EntityPath>

fn from(value: EntityPath) -> Cow<'a, EntityPath>

impl From<EntityPath> for EntityPath

fn from(value: EntityPath) -> EntityPath

impl From<EntityPath> for EntityPath

fn from(value: EntityPath) -> EntityPath

impl From<EntityPath> for EntityPathRule

Struct EntityPath

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

fn from_iter<T>(parts: T) -> EntityPath
where T: IntoIterator<Item = EntityPathPart>,

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

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

impl<Idx> Index<Idx> for EntityPath
where Idx: SliceIndex<[EntityPathPart]>,

fn to_arrow_opt<'a>( _data: impl IntoIterator<Item = Option<impl Into<Cow<'a, EntityPath>>>>, ) -> Result<Arc<dyn Array>, SerializationError>
where EntityPath: 'a,

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, EntityPath>>>, ) -> Result<Arc<dyn Array>, SerializationError>
where EntityPath: 'a,

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

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

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

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