[go: up one dir, main page]

ChunkId

Struct ChunkId 

Source
pub struct ChunkId(/* private fields */);
Expand description

A unique ID for a Chunk.

Chunks are the atomic unit of ingestion, transport, storage, events and GC in Rerun.

Internally, a Chunk is made up of rows, which are themselves uniquely identified by their RowId.

There is no relationship whatsoever between a ChunkId and the RowIds within that chunk.

§String format

Example: chunk_182342300C5F8C327a7b4a6e5a379ac4. The “chunk_” prefix is optional when parsing. See re_tuid docs for explanations of TUID namespaces.

§Uniqueness

ChunkId are assumed unique within a single Recording.

The chunk store will treat two chunks with the same ChunkId as the same, and only keep one of them (which one is kept is an arbitrary and unstable implementation detail).

This makes it easy to build and maintain secondary indices around RowIds with few to no extraneous state tracking.

§Garbage collection

Garbage collection is handled at the chunk level by first ordering the chunks based on the minimum RowId present in each of them. Garbage collection therefore happens (roughly) in the logger’s wall-clock order.

This has very important implications when inserting data far into the past or into the future: think carefully about your RowIds in these cases.

Implementations§

Source§

impl ChunkId

Source

pub const ZERO: Self

Source

pub const MAX: Self

Source

pub fn new() -> Self

Create a new unique ChunkId based on the current time.

Source

pub fn from_tuid(tuid: Tuid) -> Self

Source

pub fn as_tuid(&self) -> Tuid

Source

pub fn next(&self) -> Self

Returns the next logical ChunkId.

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

Source

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

Returns the n-next logical ChunkId.

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

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

Source

pub fn from_u128(id: u128) -> Self

Source§

impl ChunkId

Methods from Deref<Target = Tuid>§

Source

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

Source

pub const ZERO: Tuid

Source

pub const MAX: Tuid

Source

pub fn as_u128(&self) -> u128

Source

pub fn as_bytes(&self) -> [u8; 16]

Returns most significant byte first (big endian).

Source

pub fn nanos_since_epoch(&self) -> u64

Approximate nanoseconds since unix epoch.

The upper 64 bits of the Tuid.

Source

pub fn inc(&self) -> u64

The increment part of the Tuid.

The lower 64 bits of the Tuid.

Source

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.

Source

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.

Source

pub fn short_string(&self) -> String

A shortened string representation of the Tuid.

Trait Implementations§

Source§

impl Clone for ChunkId

Source§

fn clone(&self) -> ChunkId

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Component for ChunkId

Source§

fn name() -> ComponentType

The fully-qualified type of this component, e.g. rerun.components.Position2D.
Source§

impl Debug for ChunkId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for ChunkId

Source§

type Target = Tuid

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl DerefMut for ChunkId

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<'de> Deserialize<'de> for ChunkId

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ChunkId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> From<&'a ChunkId> for Cow<'a, ChunkId>

Source§

fn from(value: &'a ChunkId) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<ChunkId> for Cow<'a, ChunkId>

Source§

fn from(value: ChunkId) -> Self

Converts to this type from the input type.
Source§

impl FromStr for ChunkId

Source§

type Err = InvalidChunkIdError

The associated error which can be returned from parsing.
Source§

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

Parses a string s to return a value of this type. Read more
Source§

impl Hash for ChunkId

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Loggable for ChunkId

Source§

fn arrow_datatype() -> DataType

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

fn to_arrow_opt<'a>( _values: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, ) -> SerializationResult<ArrayRef>
where Self: 'a,

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

fn to_arrow<'a>( values: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, ) -> SerializationResult<ArrayRef>

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

fn from_arrow(array: &dyn Array) -> DeserializationResult<Vec<Self>>

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

fn arrow_empty() -> ArrayRef

Source§

fn from_arrow_opt(data: &dyn Array) -> DeserializationResult<Vec<Option<Self>>>

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

fn verify_arrow_array(data: &dyn Array) -> DeserializationResult<()>

Verifies that the given Arrow array can be deserialized into a collection of Selfs. Read more
Source§

impl Ord for ChunkId

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ChunkId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for ChunkId

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Serialize for ChunkId

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl SizeBytes for ChunkId

Source§

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap. Read more
Source§

fn is_pod() -> bool

Is Self just plain old data? Read more
Source§

fn total_size_bytes(&self) -> u64

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

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes. Read more
Source§

impl Copy for ChunkId

Source§

impl Eq for ChunkId

Source§

impl StructuralPartialEq for ChunkId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<L> ComponentBatch for L
where L: Clone + Loggable,

Source§

fn to_arrow(&self) -> Result<Arc<dyn Array>, SerializationError>

Serializes the batch into an Arrow array.
Source§

fn to_arrow_list_array(&self) -> SerializationResult<ArrowListArray>

Serializes the batch into an Arrow list array with a single component per list.
Source§

fn serialized( &self, component_descr: ComponentDescriptor, ) -> Option<SerializedComponentBatch>

Serializes the contents of this ComponentBatch. Read more
Source§

fn try_serialized( &self, component_descr: ComponentDescriptor, ) -> SerializationResult<SerializedComponentBatch>

Serializes the contents of this ComponentBatch. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,