Struct re_sdk::external::re_tuid::Tuid

pub struct Tuid {
    pub(crate) time_ns: u64,
    pub(crate) inc: u64,
}

Fields

time_ns: u64

inc: u64

Implementations

impl Tuid

pub const NAME: &'static str = "rerun.datatypes.TUID"

We give an actual name to Tuid, and inject that name into the Arrow datatype extensions, as a hack so that we can compactly format them when printing Arrow data to the terminal. Check out re_format_arrow for context.

pub fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

NOTE: This crate cannot depend on re_types_core, therefore the actual implementation of SizeBytes for Tuid lives in re_types_core and calls this method.

impl Tuid

pub const ZERO: Tuid = _

All zeroes.

pub const MAX: Tuid = _

All ones.

pub fn new() -> Tuid

Create a new unique Tuid based on the current time.

pub fn from_nanos_and_inc(time_ns: u64, inc: u64) -> Tuid

Construct a Tuid from the upper and lower halves of a u128-bit. The first should be nano-seconds since epoch.

pub fn from_u128(id: u128) -> Tuid

pub fn as_u128(&self) -> u128

pub fn nanoseconds_since_epoch(&self) -> u64

Approximate nanoseconds since unix epoch.

The upper 64 bits of the Tuid.

pub fn inc(&self) -> u64

The increment part of the Tuid.

The lower 64 bits of the Tuid.

pub fn next(&self) -> Tuid

Returns the next logical Tuid.

Wraps the monotonically increasing back to zero on overflow.

Beware: wrong usage can easily lead to conflicts. Prefer Tuid::new when unsure.

pub fn incremented_by(&self, n: u64) -> Tuid

Returns the n-next logical Tuid.

This is equivalent to calling Tuid::next n times. Wraps the monotonically increasing back to zero on overflow.

Beware: wrong usage can easily lead to conflicts. Prefer Tuid::new when unsure.

pub fn short_string(&self) -> String

A shortened string representation of the Tuid.

Trait Implementations

impl Clone for Tuid

fn clone(&self) -> Tuid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tuid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tuid

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Tuid

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

Formats the value using the given formatter.

impl From<Tuid> for Tuid

fn from(value: Tuid) -> Tuid

Converts to this type from the input type.

impl Hash for Tuid

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 Tuid

fn arrow2_datatype() -> DataType

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

fn to_arrow2_opt<'a>( _data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Tuid>>>>, ) -> Result<Box<dyn Array>, SerializationError>

where Tuid: 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow2 array.

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

where Tuid: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow2 array.

fn from_arrow2( array: &(dyn Array + 'static), ) -> Result<Vec<Tuid>, DeserializationError>

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

fn arrow_datatype() -> DataType

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

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

where Self: 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

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

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow(data: &dyn Array) -> Result<Vec<Self>, DeserializationError>

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

fn from_arrow_opt( data: &dyn Array, ) -> Result<Vec<Option<Self>>, DeserializationError>

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

fn from_arrow2_opt( data: &(dyn Array + 'static), ) -> Result<Vec<Option<Self>>, DeserializationError>

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

impl Ord for Tuid

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

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

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

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 SizeBytes for Tuid

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl Copy for Tuid

impl Eq for Tuid

impl StructuralPartialEq for Tuid