Struct RangeFrameBounds

pub struct RangeFrameBounds {
    pub order_data_type: DataType,
    pub order_type: OrderType,
    pub offset_data_type: DataType,
    pub start: RangeFrameBound,
    pub end: RangeFrameBound,
}

Fields

order_data_type: DataType

order_type: OrderType

offset_data_type: DataType

start: RangeFrameBound

end: RangeFrameBound

Implementations

impl RangeFrameBounds

pub(super) fn from_protobuf(bounds: &PbRangeFrameBounds) -> Result<Self>

pub(super) fn to_protobuf(&self) -> PbRangeFrameBounds

impl RangeFrameBounds

pub fn frame_start_of( &self, order_value: impl ToOwnedDatum, ) -> Sentinelled<Datum>

Get the frame start for a given order column value.

Examples

For the following frames:

ORDER BY x ASC RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
ORDER BY x DESC RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW

For any CURRENT ROW with any order value, the frame start is always the first-most row, which is represented by Sentinelled::Smallest.

For the following frame:

ORDER BY x ASC RANGE BETWEEN 10 PRECEDING AND CURRENT ROW

For CURRENT ROW with order value 100, the frame start is the FIRST row with order value 90.

For the following frame:

ORDER BY x DESC RANGE BETWEEN 10 PRECEDING AND CURRENT ROW

For CURRENT ROW with order value 100, the frame start is the FIRST row with order value 110.

pub fn frame_end_of(&self, order_value: impl ToOwnedDatum) -> Sentinelled<Datum>

Get the frame end for a given order column value. It’s very similar to frame_start_of, just with everything on the other direction.

pub fn first_curr_of( &self, order_value: impl ToOwnedDatum, ) -> Sentinelled<Datum>

Get the order value of the CURRENT ROW of the first frame that includes the given order value.

Examples

For the following frames:

ORDER BY x ASC RANGE BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING
ORDER BY x DESC RANGE BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING

For any given order value, the first CURRENT ROW is always the first-most row, which is represented by Sentinelled::Smallest.

For the following frame:

ORDER BY x ASC RANGE BETWEEN CURRENT ROW AND 10 FOLLOWING

For a given order value 100, the first CURRENT ROW should have order value 90.

For the following frame:

ORDER BY x DESC RANGE BETWEEN CURRENT ROW AND 10 FOLLOWING

For a given order value 100, the first CURRENT ROW should have order value 110.

pub fn last_curr_of(&self, order_value: impl ToOwnedDatum) -> Sentinelled<Datum>

Get the order value of the CURRENT ROW of the last frame that includes the given order value. It’s very similar to first_curr_of, just with everything on the other direction.

Trait Implementations

impl Clone for RangeFrameBounds

fn clone(&self) -> RangeFrameBounds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RangeFrameBounds

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

Formats the value using the given formatter.

impl Display for RangeFrameBounds

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

Formats the value using the given formatter.

impl FrameBoundsImpl for RangeFrameBounds

fn validate(&self) -> Result<()>

impl Hash for RangeFrameBounds

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 RangeFrameBounds

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

impl StructuralPartialEq for RangeFrameBounds