Enum TimeType 

pub enum TimeType {
    Sequence,
    DurationNs,
    TimestampNs,
}

The type of a TimeInt or crate::Timeline.

Variants

Sequence

Used e.g. for frames in a film.

DurationNs

Duration measured in nanoseconds.

TimestampNs

Nanoseconds since unix epoch (1970-01-01 00:00:00 UTC).

Implementations

impl TimeType

pub fn format_sequence(time_int: TimeInt) -> String

pub fn parse_sequence(s: &str) -> Option<TimeInt>

pub fn parse_time( &self, s: &str, timestamp_format: TimestampFormat, ) -> Option<TimeInt>

Parses a human-readable time string into a TimeInt.

pub fn format( &self, time_int: impl Into<TimeInt>, timestamp_format: TimestampFormat, ) -> String

pub fn format_opt( &self, time_int: impl Into<TimeInt>, timestamp_format: TimestampFormat, subsecond_decimals: RangeInclusive<usize>, ) -> String

The format will omit trailing sub-second zeroes as far as subsecond_decimals perimts it.

pub fn format_utc(&self, time_int: TimeInt) -> String

pub fn format_range( &self, time_range: AbsoluteTimeRange, timestamp_format: TimestampFormat, ) -> String

pub fn format_range_utc(&self, time_range: AbsoluteTimeRange) -> String

pub fn datatype(self) -> DataType

Returns the appropriate arrow datatype to represent this timeline.

pub fn from_arrow_datatype(datatype: &DataType) -> Option<TimeType>

pub fn make_arrow_array( self, times: impl Into<ScalarBuffer<i64>>, ) -> Arc<dyn Array>

Returns an array with the appropriate datatype.

pub fn make_arrow_array_with_nulls( self, times: impl Into<ScalarBuffer<i64>>, nulls: Option<NullBuffer>, ) -> Arc<dyn Array>

Returns an array with the appropriate datatype, attaching the supplied null buffer.

pub fn make_arrow_array_from_time_ints( self, times: impl Iterator<Item = TimeInt>, ) -> Arc<dyn Array>

Returns an array with the appropriate datatype, using None for TimeInt::STATIC.

pub fn from_arrow_array( array: &dyn Array, ) -> Result<(TimeType, &ScalarBuffer<i64>), ArrowError>

Take an array of time values, and based on its data type, figure out its TimeType and contents.

Trait Implementations

impl Clone for TimeType

fn clone(&self) -> TimeType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TimeType

impl Debug for TimeType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimeType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimeType

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

Formats the value using the given formatter.

impl Eq for TimeType

impl From<TimeType> for TimeType

fn from(value: TimeType) -> TimeType

Converts to this type from the input type.

impl FromPrimitive for TimeType

fn from_i64(n: i64) -> Option<TimeType>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<TimeType>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Hash for TimeType

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 TimeType

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for TimeType

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

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 TimeType

const IS_POD: bool = true

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.

impl StructuralPartialEq for TimeType