Skip to main content

DurationArray

Struct DurationArray 

Source
pub struct DurationArray { /* private fields */ }
Expand description

A nanosecond interval count.

A nanosecond i64 column; see the module documentation.

Implementations§

Source§

impl DurationArray

Source

pub fn try_new( values: ScalarBuffer<i64>, validity: Option<Bitmap>, ) -> Result<Self>

Builds an array from a values buffer and an optional validity bitmap.

§Errors

ValidityLengthMismatch when the bitmap does not cover exactly one bit per value.

Source

pub fn from_nanos(values: impl IntoIterator<Item = i64>) -> Self

Builds an array with no nulls from nanosecond intervals.

Source

pub fn from_opt_nanos(values: impl IntoIterator<Item = Option<i64>>) -> Self

Builds an array from optional nanosecond intervals.

Source

pub fn new_null(len: usize) -> Self

An all-null array of len slots.

Source

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

The raw nanosecond values, including the placeholder in every null slot.

Source

pub const fn values_buffer(&self) -> &ScalarBuffer<i64>

The values buffer.

Source

pub fn value(&self, index: usize) -> Option<i64>

The raw slot value at index, ignoring validity.

Returns None only when index is out of range.

Source

pub fn get(&self, index: usize) -> Option<i64>

The logical value at index: None when the slot is null or out of range.

Source

pub fn value_as_secs_f64(&self, index: usize) -> Option<f64>

The value at index in seconds, as a float.

Lossy beyond 2^53 nanoseconds (about 104 days); use Self::get when exactness matters.

Source

pub fn value_as_duration(&self, index: usize) -> Option<Duration>

The value at index as a std::time::Duration.

Returns None for a negative value, which Duration cannot represent.

Source

pub fn iter(&self) -> ArrayIter<&Self> ⓘ

Iterates over the logical values, None for nulls.

Source

pub fn slice(&self, offset: usize, len: usize) -> Self

A zero-copy sub-range, clamped to the array (the crate-wide slicing convention).

Source

pub fn try_slice(&self, offset: usize, len: usize) -> Result<Self>

Checked Self::slice.

§Errors

SliceOutOfBounds when the window leaves the array.

Source

pub fn with_validity(&self, validity: Option<Bitmap>) -> Result<Self>

Returns a copy with a different validity bitmap.

§Errors

ValidityLengthMismatch when the bitmap length is wrong.

Source

pub const fn as_primitive(&self) -> &Int64Array

The underlying i64 column, keeping this type’s DataType.

Source

pub fn from_primitive(values: &Int64Array) -> Result<Self>

Reinterprets a plain Int64 column as this temporal type.

Free: the two share a buffer layout.

§Errors

TypeMismatch when the source is not an Int64, Timestamp or Duration column.

Trait Implementations§

Source§

impl Array for DurationArray

Source§

fn as_any(&self) -> &dyn Any

Erased self, for ArrayExt::downcast.
Source§

fn data_type(&self) -> &DataType

The array’s layout.
Source§

fn len(&self) -> usize

Number of logical slots.
Source§

fn validity(&self) -> Option<&Bitmap>

The validity bitmap, or None when every slot is valid. Read more
Source§

fn slice(&self, offset: usize, len: usize) -> ArrayRef

A zero-copy sub-range. Read more
Source§

fn buffer_memory_size(&self) -> usize

Bytes of buffer memory this array pins, including shared allocations it only partly covers. Read more
Source§

fn equals(&self, other: &dyn Array) -> bool

Structural equality against another array, used by the PartialEq implementation on dyn Array. Read more
Source§

fn is_empty(&self) -> bool

Returns true when the array has no slots.
Source§

fn null_count(&self) -> usize

Number of null slots.
Source§

fn is_null(&self, index: usize) -> bool

Returns true when slot index is null. Out-of-range indices are reported as null.
Source§

fn is_valid(&self, index: usize) -> bool

Returns true when slot index holds a value.
Source§

fn children(&self) -> Vec<&ArrayRef> ⓘ

The child arrays this array owns, in field order. Empty for leaf types.
Source§

impl<'a> ArrayAccessor for &'a DurationArray

Source§

type Item = i64

The logical value type, e.g. i32, &'a str or &'a [u8].
Source§

fn accessor_len(&self) -> usize

Number of logical slots.
Source§

fn accessor_get(&self, index: usize) -> Option<i64>

The value at index, or None when the slot is null or out of range.
Source§

impl Clone for DurationArray

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DurationArray

Source§

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

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

impl Eq for DurationArray

Source§

impl FromIterator<Option<i64>> for DurationArray

Source§

fn from_iter<I: IntoIterator<Item = Option<i64>>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl FromIterator<i64> for DurationArray

Source§

fn from_iter<I: IntoIterator<Item = i64>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<'a> IntoIterator for &'a DurationArray

Source§

type Item = Option<i64>

The type of the elements being iterated over.
Source§

type IntoIter = ArrayIter<&'a DurationArray>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for DurationArray

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<A> IntoArrayRef for A
where A: Array,

Source§

fn into_array_ref(self) -> ArrayRef

Moves self into a shared, dynamically typed column.
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.