Struct re_entity_db::instance_path::InstancePath

pub struct InstancePath {
    pub entity_path: EntityPath,
    pub instance: Instance,
}

The path to either a specific instance of an entity, or the whole entity.

Fields

entity_path: EntityPath

instance: Instance

If this is a concrete instance, what instance index are we?

If we refer to all instances, [Instance::ALL] is used.

Implementations

impl InstancePath

pub fn entity_all(entity_path: EntityPath) -> Self

Indicate the whole entity (all instances of it).

For example: the whole point cloud, rather than a specific point.

pub fn instance(entity_path: EntityPath, instance: Instance) -> Self

Indicate a specific instance of the entity, e.g. a specific point in a point cloud entity.

pub fn is_all(&self) -> bool

Do we refer to the whole entity (all instances of it)?

For example: the whole point cloud, rather than a specific point.

pub fn versioned(&self, row_id: RowId) -> VersionedInstancePath

Versions this instance path by stamping it with the specified [RowId].

pub fn hash(&self) -> InstancePathHash

Trait Implementations

impl Clone for InstancePath

fn clone(&self) -> InstancePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstancePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstancePath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstancePath

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

Formats the value using the given formatter.

impl From<EntityPath> for InstancePath

fn from(entity_path: EntityPath) -> Self

Converts to this type from the input type.

impl FromStr for InstancePath

type Err = PathParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for InstancePath

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 InstancePath

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

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

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

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 InstancePath

impl StructuralPartialEq for InstancePath