Struct re_log_types::path::EntityPathPart

pub struct EntityPathPart(InternedString);

The different parts that make up an EntityPath.

A non-empty string.

Note that the contents of the string is NOT escaped, so escaping needs to be done when printing this using Self::escaped_string.

Because of this, EntityPathPart does NOT implement AsRef<str> etc, nor does it implement Display: you must explicitly chose either the escaped or the unescaped version of it.

In the file system analogy, this is the name of a folder.

Tuple Fields

0: InternedString

We use an interned string for fast copies, fast hashing, and to save memory. Note that re_string_interner never frees memory, but even if a user allocates 100k different entity parts (which is crazy many lot), the memory usage will still only be in the low megabytes.

Implementations

impl EntityPathPart

pub fn new(unescaped_string: impl Into<InternedString>) -> Self

The given string is expected to be unescaped, i.e. any \ is treated as a normal character.

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

Unescape the string, forgiving any syntax error with a best-effort approach.

pub fn parse_forgiving_with_warning( input: &str, warnings: Option<&mut Vec<String>> ) -> Self

Unescape the string, forgiving any syntax error with a best-effort approach.

Returns a warnings for potentially serious problems:

• any unknown escape sequences
• unescaped spaces

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

Unescape the string, returning errors on wrongly escaped input.

pub fn ui_string(&self) -> String

The style of string to use in a UI

pub fn unescaped_str(&self) -> &str

The unescaped string.

Use Self::escaped_string to escape it.

Use this when it is standalone in a ui somewhere.

pub fn escaped_string(&self) -> String

Use this when it is part of a full entity path.

Trait Implementations

impl Clone for EntityPathPart

fn clone(&self) -> EntityPathPart

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityPathPart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityPathPart

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for EntityPathPart

fn from(part: &str) -> Self

Converts to this type from the input type.

impl From<InternedString> for EntityPathPart

fn from(part: InternedString) -> Self

Converts to this type from the input type.

impl From<String> for EntityPathPart

fn from(part: String) -> Self

Converts to this type from the input type.

impl FromIterator<EntityPathPart> for EntityPath

fn from_iter<T: IntoIterator<Item = EntityPathPart>>(parts: T) -> Self

Creates a value from an iterator.

impl Hash for EntityPathPart

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EntityPathPart

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EntityPathPart

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for EntityPathPart

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for EntityPathPart

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EntityPathPart

impl StructuralPartialEq for EntityPathPart