Struct FieldRange

pub struct FieldRange {
    pub field_path: String,
    pub start: Option<FieldValue>,
    pub start_inclusive: bool,
    pub end: Option<FieldValue>,
    pub end_inclusive: bool,
}

A range of values to be used in a MultiDeleteRequest operation.

FieldRange is used as the least significant component in a partially specified key value in order to create a value range for an operation that returns multiple rows or keys. The data types supported by FieldRange are limited to the atomic types which are valid for primary keys.

The least significant component of a key is the first component of the key that is not fully specified. For example, if the primary key for a table is defined as the tuple:

<a, b, c>

A FieldRange can be specified for:

“a” if the primary key supplied is empty. “b” if the primary key supplied to the operation has a concrete value for “a” but not for “b” or “c”.

The field_path specified must name a field in a table’s primary key. The start and end values used must be of the same type and that type must match the type of the field specified.

Validation of this struct is performed when it is used in an operation. Validation includes verifying that the field is in the required key and, in the case of a composite key, that the field is in the proper order relative to the key used in the operation.

Fields

field_path: String

start: Option<FieldValue>

start_inclusive: bool

end: Option<FieldValue>

end_inclusive: bool

Trait Implementations

impl Debug for FieldRange

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

Formats the value using the given formatter.

impl Default for FieldRange

fn default() -> FieldRange

Returns the “default value” for a type.