Struct RangeQueryOptions

pub struct RangeQueryOptions {
    pub keep_extra_timelines: bool,
    pub keep_extra_components: bool,
    pub include_extended_bounds: bool,
}

Fields

keep_extra_timelines: bool

Should the results contain all extra timeline information available in the Chunk?

While this information can be useful in some cases, it comes at a performance cost.

keep_extra_components: bool

Should the results contain all extra component information available in the Chunk?

While this information can be useful in some cases, it comes at a performance cost.

include_extended_bounds: bool

If true, the results will include one extra tick on each side of the range.

Note: this is different from simply subtracting/adding one to the time range of the query, as this will work even with non-contiguous time values, and even if these non-contiguous jumps happen across multiple chunks.

Consider for example this data:

┌──────────────────────────────────┬───────────────┬──────────────────────┐
│ RowId                            ┆ frame_nr      ┆ Scalar               │
╞══════════════════════════════════╪═══════════════╪══════════════════════╡
│ 17E9C11C655B21A9006568024DA10857 ┆ 0             ┆ [2]                  │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ 17E9C11C6560E8A6006568024DA10859 ┆ 2             ┆ [2.04]               │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ 17E9C11C656504F0006568024DA1085B ┆ 4             ┆ [2.08]               │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ 17E9C11C65693204006568024DA1085D ┆ 6             ┆ [2.12]               │
└──────────────────────────────────┴───────────────┴──────────────────────┘

• A RangeQuery(#2, #4) would yield frames #2 and #4.
• A RangeQuery(#1, #5) would still only yield frames #2 and #4.
• A RangeQuery(#2, #4, include_extended_bounds=true), on the other hand, would yield all of frames #0, #2, #4 and #6.

Implementations

impl RangeQueryOptions

pub const DEFAULT: Self = _

Trait Implementations

impl Clone for RangeQueryOptions

fn clone(&self) -> RangeQueryOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeQueryOptions

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

Formats the value using the given formatter.

impl Default for RangeQueryOptions

fn default() -> Self

Returns the “default value” for a type.

impl Hash for RangeQueryOptions

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 PartialEq for RangeQueryOptions

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

impl StructuralPartialEq for RangeQueryOptions