Struct IndexColumnDescriptor

pub struct IndexColumnDescriptor {
    timeline: Timeline,
    datatype: DataType,
    is_sorted: bool,
}

Describes a time column, such as log_time.

Fields

timeline: Timeline

The timeline this column is associated with.

datatype: DataType

The Arrow datatype of the column.

is_sorted: bool

Are the indices in this column sorted?

false means either “unsorted” or “unknown”.

Implementations

impl IndexColumnDescriptor

pub fn new_null(name: TimelineName) -> Self

Used when returning a null column, i.e. when a lookup failed.

pub fn from_timeline(timeline: Timeline, is_sorted: bool) -> Self

pub fn timeline(&self) -> Timeline

pub fn timeline_name(&self) -> TimelineName

pub fn column_name(&self) -> &str

pub fn datatype(&self) -> &ArrowDatatype

pub fn is_sorted(&self) -> bool

Are the indices in this column sorted?

false means either “unsorted” or “unknown”.

pub fn to_arrow_field(&self) -> ArrowField

Trait Implementations

impl Clone for IndexColumnDescriptor

fn clone(&self) -> IndexColumnDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexColumnDescriptor

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

Formats the value using the given formatter.

impl<'a> From<&'a IndexColumnDescriptor> for ColumnDescriptorRef<'a>

fn from(desc: &'a IndexColumnDescriptor) -> Self

Converts to this type from the input type.

impl From<Timeline> for IndexColumnDescriptor

fn from(timeline: Timeline) -> Self

Converts to this type from the input type.

impl Hash for IndexColumnDescriptor

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 IndexColumnDescriptor

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

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

fn partial_cmp(&self, other: &Self) -> 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 TryFrom<&Field> for IndexColumnDescriptor

type Error = UnsupportedTimeType

The type returned in the event of a conversion error.

fn try_from(field: &ArrowField) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for IndexColumnDescriptor

impl StructuralPartialEq for IndexColumnDescriptor