KeyRangeMode

Namespace: FoundationDB.Client · enum

Implements: IComparable, ISpanFormattable, IFormattable, IConvertible

Defines how a boundary key should be considered in a FdbKeyRange

Fields

Default

Default = 0

Use the default behavior for this parameter

This is usually for Begin keys, and for End keys

Exclusive

Exclusive = 2

The key is excluded from the range

If this is the Begin key, its successor will be used (key.`\x00`).

If this is the End key, it is used as-is.

Inclusive

Inclusive = 1

The key is included in the range

If this is the Begin key, it is used as-is.

If this is the End key, its Successor will be used (key.`\x00`)

Last

Last = 4

The key and all of its children that can be represented by tuples are included in the range

This is not allowed for Begin keys.

If this is the End key, its last valid element will be used (key.`\xFF`)

NextSibling

NextSibling = 3

The key and all of its children is not included in the range

The next sibling will be used for both Begin and End Key (increment(key))