#[non_exhaustive]pub struct LedgerPosition {
pub checkpoint: Option<u64>,
pub transaction_index: Option<u64>,
pub event_index: Option<u32>,
}Expand description
A point in ledger order: the boundary between the items whose keys sort below this position and the items whose keys sort at or above it.
An item’s key is (sequence_number) for a Checkpoint, (checkpoint,
transaction_index) for an ExecutedTransaction, and (checkpoint,
transaction_index, event_index) for an Event. Keys and positions sort
lexicographically, with unset fields counting as 0.
An index past the last transaction of a checkpoint, or past the last event of
a transaction, names the start of the next one, so different positions can
name the same boundary: after the last of checkpoint c’s n transactions,
both (c, n) and (c + 1, 0) name the start of checkpoint c + 1.
Sorting never contradicts ledger order: a position that sorts below another
is at or before it. Use comparisons to drop what is behind, and never assume
that positions that differ name different boundaries.
To bound a request at a position: as its start, set start_checkpoint to
checkpoint and, when either index is nonzero, the start index fields to
both indexes, including one that is 0 (start_transaction_index, plus
start_event_index for events). As its end, set end_checkpoint to
checkpoint when both indexes are 0; otherwise set end_checkpoint to
checkpoint + 1 and the end index fields to both indexes
(end_transaction_index, plus end_event_index for events). Checkpoint
positions carry only checkpoint, so they set only start_checkpoint or
end_checkpoint.
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.checkpoint: Option<u64>Checkpoint sequence number.
transaction_index: Option<u64>Zero-based position of a transaction within checkpoint.
event_index: Option<u32>Zero-based index of an event within its transaction’s event list. Event streams only.
Implementations§
Source§impl LedgerPosition
impl LedgerPosition
pub const CHECKPOINT_FIELD: &'static MessageField
pub const TRANSACTION_INDEX_FIELD: &'static MessageField
pub const EVENT_INDEX_FIELD: &'static MessageField
Source§impl LedgerPosition
impl LedgerPosition
pub fn path_builder() -> LedgerPositionFieldPathBuilder
Source§impl LedgerPosition
impl LedgerPosition
pub const fn const_default() -> Self
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 transaction_index_opt_mut(&mut self) -> Option<&mut u64>
pub fn transaction_index_opt_mut(&mut self) -> Option<&mut u64>
Sourcepub fn transaction_index_mut(&mut self) -> &mut u64
pub fn transaction_index_mut(&mut self) -> &mut u64
Returns a mutable reference to transaction_index.
If the field is unset, it is first initialized with the default value.
Sourcepub fn transaction_index_opt(&self) -> Option<u64>
pub fn transaction_index_opt(&self) -> Option<u64>
Sourcepub fn set_transaction_index(&mut self, field: u64)
pub fn set_transaction_index(&mut self, field: u64)
Sets transaction_index with the provided value.
Sourcepub fn with_transaction_index(self, field: u64) -> Self
pub fn with_transaction_index(self, field: u64) -> Self
Sets transaction_index with the provided value.
Sourcepub fn event_index_opt_mut(&mut self) -> Option<&mut u32>
pub fn event_index_opt_mut(&mut self) -> Option<&mut u32>
Sourcepub fn event_index_mut(&mut self) -> &mut u32
pub fn event_index_mut(&mut self) -> &mut u32
Returns a mutable reference to event_index.
If the field is unset, it is first initialized with the default value.
Sourcepub fn event_index_opt(&self) -> Option<u32>
pub fn event_index_opt(&self) -> Option<u32>
Sourcepub fn set_event_index(&mut self, field: u32)
pub fn set_event_index(&mut self, field: u32)
Sets event_index with the provided value.
Sourcepub fn with_event_index(self, field: u32) -> Self
pub fn with_event_index(self, field: u32) -> Self
Sets event_index with the provided value.
Source§impl LedgerPosition
impl LedgerPosition
Sourcepub fn checkpoint(&self) -> u64
pub fn checkpoint(&self) -> u64
Returns the value of checkpoint, or the default value if checkpoint is unset.
Sourcepub fn transaction_index(&self) -> u64
pub fn transaction_index(&self) -> u64
Returns the value of transaction_index, or the default value if transaction_index is unset.
Sourcepub fn event_index(&self) -> u32
pub fn event_index(&self) -> u32
Returns the value of event_index, or the default value if event_index is unset.
Trait Implementations§
Source§impl Clone for LedgerPosition
impl Clone for LedgerPosition
impl Copy for LedgerPosition
Source§impl Debug for LedgerPosition
impl Debug for LedgerPosition
Source§impl Default for LedgerPosition
impl Default for LedgerPosition
§impl<'de> Deserialize<'de> for LedgerPosition
impl<'de> Deserialize<'de> for LedgerPosition
§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 LedgerPosition
Source§impl Hash for LedgerPosition
impl Hash for LedgerPosition
Source§impl Message for LedgerPosition
impl Message for LedgerPosition
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 LedgerPosition
impl MessageFields for LedgerPosition
const FIELDS: &'static [&'static MessageField]
Source§impl PartialEq for LedgerPosition
impl PartialEq for LedgerPosition
§impl Serialize for LedgerPosition
impl Serialize for LedgerPosition
impl StructuralPartialEq for LedgerPosition
Auto Trait Implementations§
impl Freeze for LedgerPosition
impl RefUnwindSafe for LedgerPosition
impl Send for LedgerPosition
impl Sync for LedgerPosition
impl Unpin for LedgerPosition
impl UnsafeUnpin for LedgerPosition
impl UnwindSafe for LedgerPosition
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.