Struct Timeline

pub struct Timeline {
    name: TimelineName,
    typ: TimeType,
}

A time frame/space, e.g. log_time or frame_nr, coupled with the type of time it keeps.

Fields

name: TimelineName

Name of the timeline (e.g. log_time).

typ: TimeType

Sequence or time?

Implementations

impl Timeline

pub fn new(name: impl Into<TimelineName>, typ: TimeType) -> Self

pub fn new_sequence(name: impl Into<TimelineName>) -> Self

For things like camera frames or iteration count.

pub fn new_duration(name: impl Into<TimelineName>) -> Self

For relative times (e.g. seconds since start).

pub fn new_timestamp(name: impl Into<TimelineName>) -> Self

For absolute timestamps.

pub fn new_temporal(name: impl Into<TimelineName>) -> Self

👎Deprecated since 0.23.0: Use Timeline::new_duration or new_timestamp instead

pub fn name(&self) -> &TimelineName

pub fn typ(&self) -> TimeType

pub fn log_time() -> Self

The log time timeline to which all API functions will always log.

This timeline is automatically maintained by the SDKs and captures the wall-clock time at which point the data was logged (according to the client’s wall-clock).

pub fn log_tick() -> Self

The log tick timeline to which all API functions will always log.

This timeline is automatically maintained by the SDKs and captures the logging tick at which point the data was logged. The logging tick is monotically incremented each time the client calls one of the logging methods on a RecordingStream.

pub fn format_time_range( &self, time_range: &ResolvedTimeRange, timestamp_format: TimestampFormat, ) -> String

Returns a formatted string of time_range on this Timeline.

pub fn format_time_range_utc(&self, time_range: &ResolvedTimeRange) -> String

Returns a formatted string of time_range on this Timeline.

pub fn datatype(&self) -> DataType

Returns the appropriate arrow datatype to represent this timeline.

Trait Implementations

impl Clone for Timeline

fn clone(&self) -> Timeline

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timeline

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timeline

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Timeline

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

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 Timeline

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SizeBytes for Timeline

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 Copy for Timeline

impl Eq for Timeline

impl IsEnabled for Timeline

impl StructuralPartialEq for Timeline