Struct TimeColumn 

pub struct TimeColumn { /* private fields */ }

Implementations

impl TimeColumn

pub fn builder(timeline: Timeline) -> TimeColumnBuilder

Initializes a new TimeColumnBuilder.

impl TimeColumn

pub fn new( is_sorted: Option<bool>, timeline: Timeline, times: ScalarBuffer<i64>, ) -> TimeColumn

Creates a new TimeColumn.

Iff you know for sure whether the data is already appropriately sorted or not, specify is_sorted. When left unspecified (None), it will be computed in O(n) time.

For a row-oriented constructor, see Self::builder.

pub fn new_sequence( name: impl Into<TimelineName>, times: impl IntoIterator<Item = impl Into<i64>>, ) -> TimeColumn

Creates a new TimeColumn of sequence type.

pub fn new_duration_secs( name: impl Into<TimelineName>, seconds: impl IntoIterator<Item = impl Into<f64>>, ) -> TimeColumn

Creates a new TimeColumn of duration type, in seconds.

pub fn new_timestamp_secs_since_epoch( name: impl Into<TimelineName>, seconds: impl IntoIterator<Item = impl Into<f64>>, ) -> TimeColumn

Creates a new TimeColumn of duration type, in seconds.

pub fn new_seconds( name: impl Into<TimelineName>, seconds: impl IntoIterator<Item = impl Into<f64>>, ) -> TimeColumn

👎Deprecated: Use TimeColumn::new_duration_secs or new_timestamp_secs_since_epoch instead

Creates a new TimeColumn of duration type, in seconds.

pub fn new_duration_nanos( name: impl Into<TimelineName>, nanos: impl IntoIterator<Item = impl Into<i64>>, ) -> TimeColumn

Creates a new TimeColumn measuring duration in nanoseconds.

pub fn new_timestamp_nanos_since_epoch( name: impl Into<TimelineName>, nanos: impl IntoIterator<Item = impl Into<i64>>, ) -> TimeColumn

Creates a new TimeColumn of timestamps, as nanoseconds since unix epoch.

pub fn new_nanos( name: impl Into<TimelineName>, nanos: impl IntoIterator<Item = impl Into<i64>>, ) -> TimeColumn

👎Deprecated: Use TimeColumn::new_duration_nanos or new_timestamp_nanos_since_epoch instead

Creates a new TimeColumn of nanoseconds type.

pub fn read_array( array: &dyn Array, ) -> Result<ScalarBuffer<i64>, TimeColumnError>

Parse the given ArrowArray as a time column.

Results in an error if the array is of the wrong datatype, or if it contains nulls.

pub fn read_nullable_array( array: &dyn Array, ) -> Result<(ScalarBuffer<i64>, Option<NullBuffer>), TimeColumnError>

Parse the given ArrowArray as a time column where null values are acceptable.

Results in an error if the array is of the wrong datatype.

impl TimeColumn

pub fn timeline(&self) -> &Timeline

pub fn name(&self) -> &str

pub fn time_range(&self) -> AbsoluteTimeRange

pub fn times_buffer(&self) -> &ScalarBuffer<i64>

pub fn times_array(&self) -> Arc<dyn Array>

Returns an array with the appropriate datatype.

pub fn times_raw(&self) -> &[i64]

All times in a time column are guaranteed not to have the value i64::MIN (which is reserved for static data).

pub fn times_nonmin(&self) -> impl DoubleEndedIterator

All times in a time column are guaranteed not to have the value i64::MIN (which is reserved for static data).

pub fn times(&self) -> impl DoubleEndedIterator

pub fn num_rows(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn time_range_per_component( &self, components: &ChunkComponents, ) -> HashMap<ComponentDescriptor, AbsoluteTimeRange, BuildHasherDefault<NoHashHasher<ComponentDescriptor>>>

Computes the time range covered by each individual component column.

This is different from the time range covered by the TimeColumn as a whole because component columns are potentially sparse.

This is crucial for indexing and queries to work properly.

impl TimeColumn

pub fn sanity_check(&self) -> Result<(), ChunkError>

Returns an error if the Chunk’s invariants are not upheld.

Costly checks are only run in debug builds.

impl TimeColumn

pub fn concatenated(&self, rhs: &TimeColumn) -> Option<TimeColumn>

Concatenates two TimeColumns into a new one.

The order of the arguments matter: self‘s contents will precede rhs’ contents in the returned TimeColumn.

This will return None if the time chunks do not share the same timeline.

impl TimeColumn

pub fn is_sorted(&self) -> bool

Is the timeline sorted?

This is O(1) (cached).

See also Self::is_sorted_uncached.

pub fn is_sorted_uncached(&self) -> bool

Like Self::is_sorted, but actually checks the entire dataset rather than relying on the cached value.

O(n). Useful for tests/debugging, or when you just don’t know.

See also Self::is_sorted.

impl TimeColumn

pub fn row_sliced(&self, index: usize, len: usize) -> TimeColumn

Slices the TimeColumn vertically.

The result is a new TimeColumn with the same timelines and (potentially) less rows.

This cannot fail nor panic: index and len will be capped so that they cannot run out of bounds. This can result in an empty TimeColumn being returned if the slice is completely OOB.

pub fn emptied(&self) -> TimeColumn

Empties the TimeColumn vertically.

The result is a new TimeColumn with the same columns but zero rows.

Trait Implementations

impl Clone for TimeColumn

fn clone(&self) -> TimeColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeColumn

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

Formats the value using the given formatter.

impl PartialEq for TimeColumn

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

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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 Eq for TimeColumn

impl StructuralPartialEq for TimeColumn