Struct re_sdk::InstanceKey

pub struct InstanceKey(pub u64);

Component: A unique numeric identifier for each individual instance within a batch.

Tuple Fields

0: u64

Implementations

impl InstanceKey

pub const SPLAT: InstanceKey = _

Draw order used for images if no draw order was specified.

impl InstanceKey

pub fn from_iter( it: impl IntoIterator<Item = impl Into<InstanceKey>> ) -> Vec<InstanceKey>

pub fn is_splat(self) -> bool

Are we referring to all instances of the entity (e.g. all points in a point cloud entity)?

The opposite of Self::is_specific.

pub fn is_specific(self) -> bool

Are we referring to a specific instance of the entity (e.g. a specific point in a point cloud)?

The opposite of Self::is_splat.

pub fn specific_index(self) -> Option<InstanceKey>

Returns None if splat, otherwise the index.

pub fn from_2d_image_coordinate(_: [u32; 2], image_width: u64) -> InstanceKey

Creates a new InstanceKey that identifies a 2d coordinate.

pub fn to_2d_image_coordinate(self, image_width: u64) -> [u32; 2]

Retrieves 2d image coordinates (x, y) encoded in an instance key

Trait Implementations

impl Clone for InstanceKey

fn clone(&self) -> InstanceKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstanceKey

fn deserialize<__D>( __deserializer: __D ) -> Result<InstanceKey, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InstanceKey

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

Formats the value using the given formatter.

impl From<u64> for InstanceKey

fn from(value: u64) -> InstanceKey

Converts to this type from the input type.

impl Hash for InstanceKey

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

where __H: Hasher,

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 Loggable for InstanceKey

type Name = ComponentName

fn name() -> <InstanceKey as Loggable>::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, InstanceKey>>>> ) -> Result<Box<dyn Array>, SerializationError>

where InstanceKey: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::arrow_field.

fn from_arrow_opt( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Option<InstanceKey>>, DeserializationError>

where InstanceKey: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn from_arrow( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<InstanceKey>, DeserializationError>

where InstanceKey: Sized,

Given an Arrow array, deserializes it into a collection of Loggables.

fn extended_arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, including datatype extensions.

fn arrow_field() -> Field

The underlying arrow2::datatypes::Field, including datatype extensions.

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

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::arrow_field.

impl Ord for InstanceKey

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for InstanceKey

impl Eq for InstanceKey

impl StructuralEq for InstanceKey

impl StructuralPartialEq for InstanceKey