Struct Instance 

pub struct Instance(/* private fields */);

A unique numeric index for each individual instance within a batch.

Use Instance::ALL to refer to all instances in a batch.

Implementations

impl Instance

pub const ALL: Instance

Refer to all instances in a batch.

pub fn get(self) -> u64

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

pub fn is_all(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_all.

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

Returns None if ALL, otherwise the index.

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

Creates a new Instance that identifies a 2D coordinate.

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

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

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Instance

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

Formats the value using the given formatter.

impl From<u64> for Instance

fn from(instance: u64) -> Instance

Converts to this type from the input type.

impl Hash for Instance

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 Ord for Instance

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

Restrict a value to a certain interval.

impl PartialEq for Instance

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Instance

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Instance

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 SyntaxHighlighting for Instance

fn syntax_highlight_into(&self, builder: &mut SyntaxHighlightedBuilder)

fn syntax_highlighted(&self, style: &Style) -> LayoutJob

impl Copy for Instance

impl Eq for Instance

impl StructuralPartialEq for Instance