#[non_exhaustive]pub struct Watermark {
pub cursor: Option<Bytes>,
pub checkpoint: Option<u64>,
pub cursor_position: Option<LedgerPosition>,
}Expand description
Progress of a scan, carried on every response frame, whether or not the frame delivers a matching item. Watermarks never regress in the requested ordering, but consecutive frames may carry the same watermark when additional work does not advance the safe resume frontier.
A watermark has two parts:
- The resume point, in two forms:
cursor, opaque, for the server, andcursor_position, in ledger coordinates, for clients to order frames and drop duplicates. - Coverage:
checkpoint, the boundary checkpoint the scan has proven fully covered. It trails the resume point.
To continue in the same direction, set the request’s start (ascending) or
end (descending) at cursor_position. To read in the other direction, set
the other bound at cursor_position from a frame without an item; from a
frame with an item, start a page after the item at its key with the finest
index incremented, or end a page before it at its key. In both cases pass
cursor as options.after with a start and as options.before with an
end.
For example, with after = A, before = B, ordering = DESCENDING, and
limit = N, the response contains up to N matching items in descending
order from the interval (A, B). If the response ends with
QUERY_END_REASON_ITEM_LIMIT, resume by keeping after = A and setting
before to the last Watermark.cursor received. That cursor is the
lowest position reached in ledger order, so it becomes the next exclusive
upper bound.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.cursor: Option<Bytes>Opaque cursor at the resume point. Set on every watermark. Use as
options.after (ascending) or options.before (descending) on the next
request to resume from here. The most recently received cursor is always
the safe resume point.
Pass cursors back unchanged; never compare or inspect them. Cursors that differ can name the same point, and their encoding may change.
checkpoint: Option<u64>The inclusive boundary checkpoint that the scan has fully covered within
the request’s effective interval, in the request’s ordering direction: an
ascending scan has emitted every matching item in the interval at
checkpoints <= checkpoint (strictly greater ones may still hold
matches); a descending scan has emitted every matching item in the
interval at checkpoints >= checkpoint. This boundary never regresses in
the scan direction, but it may repeat while the cursor advances.
A starting cursor vouches for what precedes it: a scan resumed from an
after cursor in checkpoint c may report c - 1 from its first frame,
and a descending scan resumed from a before cursor in c may report
c + 1. Otherwise this is unset until the scan’s first checkpoint is
fully covered. A watermark still has a valid resume cursor while this
field is unset.
cursor_position: Option<LedgerPosition>The resume point in ledger coordinates. Set on every watermark by servers that support it.
Ascending, every match from the request’s start up to (excluding)
cursor_position has been delivered. Descending, every match from
cursor_position up to (excluding) the request’s end has been delivered.
On a frame that carries an item, ascending, it is the boundary just past
the item, so it is not the item’s own key: it is that key with its finest
index incremented (event_index for events, transaction_index for
transactions, checkpoint for checkpoints). Descending, it is the boundary
just before the item, which is the item’s key.
It never moves before the request’s start (ascending) or past its end
(descending), so an ascending request that starts beyond what the server
has indexed gets its start echoed back: the resume point says where the
client is, not where the ledger is. cursor may then name an earlier
point; bounds intersect, so resuming with both starts at
cursor_position.
Implementations§
Source§impl Watermark
impl Watermark
pub const CURSOR_FIELD: &'static MessageField
pub const CHECKPOINT_FIELD: &'static MessageField
pub const CURSOR_POSITION_FIELD: &'static MessageField
Source§impl Watermark
impl Watermark
pub fn path_builder() -> WatermarkFieldPathBuilder
Source§impl Watermark
impl Watermark
pub const fn const_default() -> Self
Sourcepub fn cursor_opt(&self) -> Option<&[u8]>
pub fn cursor_opt(&self) -> Option<&[u8]>
Sourcepub fn set_cursor<T: Into<Bytes>>(&mut self, field: T)
pub fn set_cursor<T: Into<Bytes>>(&mut self, field: T)
Sets cursor with the provided value.
Sourcepub fn with_cursor<T: Into<Bytes>>(self, field: T) -> Self
pub fn with_cursor<T: Into<Bytes>>(self, field: T) -> Self
Sets cursor with the provided value.
Sourcepub fn checkpoint_opt_mut(&mut self) -> Option<&mut u64>
pub fn checkpoint_opt_mut(&mut self) -> Option<&mut u64>
Sourcepub fn checkpoint_mut(&mut self) -> &mut u64
pub fn checkpoint_mut(&mut self) -> &mut u64
Returns a mutable reference to checkpoint.
If the field is unset, it is first initialized with the default value.
Sourcepub fn checkpoint_opt(&self) -> Option<u64>
pub fn checkpoint_opt(&self) -> Option<u64>
Sourcepub fn set_checkpoint(&mut self, field: u64)
pub fn set_checkpoint(&mut self, field: u64)
Sets checkpoint with the provided value.
Sourcepub fn with_checkpoint(self, field: u64) -> Self
pub fn with_checkpoint(self, field: u64) -> Self
Sets checkpoint with the provided value.
Sourcepub fn cursor_position(&self) -> &LedgerPosition
pub fn cursor_position(&self) -> &LedgerPosition
Returns the value of cursor_position, or the default value if cursor_position is unset.
Sourcepub fn cursor_position_opt_mut(&mut self) -> Option<&mut LedgerPosition>
pub fn cursor_position_opt_mut(&mut self) -> Option<&mut LedgerPosition>
Sourcepub fn cursor_position_mut(&mut self) -> &mut LedgerPosition
pub fn cursor_position_mut(&mut self) -> &mut LedgerPosition
Returns a mutable reference to cursor_position.
If the field is unset, it is first initialized with the default value.
Sourcepub fn cursor_position_opt(&self) -> Option<&LedgerPosition>
pub fn cursor_position_opt(&self) -> Option<&LedgerPosition>
Sourcepub fn set_cursor_position<T: Into<LedgerPosition>>(&mut self, field: T)
pub fn set_cursor_position<T: Into<LedgerPosition>>(&mut self, field: T)
Sets cursor_position with the provided value.
Sourcepub fn with_cursor_position<T: Into<LedgerPosition>>(self, field: T) -> Self
pub fn with_cursor_position<T: Into<LedgerPosition>>(self, field: T) -> Self
Sets cursor_position with the provided value.
Trait Implementations§
§impl<'de> Deserialize<'de> for Watermark
impl<'de> Deserialize<'de> for Watermark
§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
impl Eq for Watermark
Source§impl Message for Watermark
impl Message for Watermark
Source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Source§fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>where
Self: Sized,
Source§fn encode_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
Source§fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
fn encode_length_delimited(
&self,
buf: &mut impl BufMut,
) -> Result<(), EncodeError>where
Self: Sized,
Source§fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8> ⓘwhere
Self: Sized,
Source§fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Source§fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>where
Self: Default,
Source§fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self. Read moreSource§fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>where
Self: Sized,
self.Source§impl MessageFields for Watermark
impl MessageFields for Watermark
const FIELDS: &'static [&'static MessageField]
impl StructuralPartialEq for Watermark
Auto Trait Implementations§
impl !Freeze for Watermark
impl RefUnwindSafe for Watermark
impl Send for Watermark
impl Sync for Watermark
impl Unpin for Watermark
impl UnsafeUnpin for Watermark
impl UnwindSafe for Watermark
Blanket Implementations§
§impl<U> As for U
impl<U> As for U
§fn as_<T>(self) -> Twhere
T: CastFrom<U>,
U: Sized,
fn as_<T>(self) -> Twhere
T: CastFrom<U>,
U: Sized,
self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read moreSource§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Source§impl<'de, T> FromBcs for Twhere
T: Deserialize<'de>,
impl<'de, T> FromBcs for Twhere
T: Deserialize<'de>,
fn from_bcs<'de>(bytes: &'de [u8]) -> Result<Self, Error>where
Self: Deserialize<'de>,
fn from_bcs_base64(base64: &str) -> Result<Self, Error>where
Self: DeserializeOwned,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request§impl<L> LayerExt<L> for L
impl<L> LayerExt<L> for L
§fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>where
L: Layer<S>,
Layered].§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.