pub struct Listen<K: Codec, V: Codec, T, D> {
handle: ReadHandle<K, V, T, D>,
watch: StateWatch<K, V, T, D>,
as_of: Antichain<T>,
since: Antichain<T>,
frontier: Antichain<T>,
}
Expand description
An ongoing subscription of updates to a shard.
Fields§
§handle: ReadHandle<K, V, T, D>
§watch: StateWatch<K, V, T, D>
§as_of: Antichain<T>
§since: Antichain<T>
§frontier: Antichain<T>
Implementations§
Source§impl<K, V, T, D> Listen<K, V, T, D>
impl<K, V, T, D> Listen<K, V, T, D>
async fn new( handle: ReadHandle<K, V, T, D>, as_of: Antichain<T>, ) -> Result<Self, Since<T>>
Sourcepub fn frontier(&self) -> &Antichain<T>
pub fn frontier(&self) -> &Antichain<T>
An exclusive upper bound on the progress of this Listen.
Sourcepub async fn next(
&mut self,
retry: Option<RetryParameters>,
) -> (Vec<LeasedBatchPart<T>>, Antichain<T>)
pub async fn next( &mut self, retry: Option<RetryParameters>, ) -> (Vec<LeasedBatchPart<T>>, Antichain<T>)
Attempt to pull out the next values of this subscription.
The returned LeasedBatchPart
is appropriate to use with
crate::fetch::fetch_leased_part
.
The returned Antichain
represents the subscription progress as it will
be after the returned parts are fetched.
Source§impl<K, V, T, D> Listen<K, V, T, D>
impl<K, V, T, D> Listen<K, V, T, D>
Sourcepub async fn fetch_next(
&mut self,
) -> Vec<ListenEvent<T, ((Result<K, String>, Result<V, String>), T, D)>>
pub async fn fetch_next( &mut self, ) -> Vec<ListenEvent<T, ((Result<K, String>, Result<V, String>), T, D)>>
Attempt to pull out the next values of this subscription.
The updates received in ListenEvent::Updates should be assumed to be in arbitrary order
and not necessarily consolidated. However, the timestamp of each individual update will be
greater than or equal to the last received ListenEvent::Progress frontier (or this
Listen’s initial as_of
frontier if no progress event has been emitted yet) and less
than the next ListenEvent::Progress frontier.
If you have a use for consolidated listen output, given that snapshots can’t be consolidated, come talk to us!
Sourcepub fn into_stream(
self,
) -> impl Stream<Item = ListenEvent<T, ((Result<K, String>, Result<V, String>), T, D)>>
pub fn into_stream( self, ) -> impl Stream<Item = ListenEvent<T, ((Result<K, String>, Result<V, String>), T, D)>>
Convert listener into futures::Stream
Source§impl<K, V, T, D> Listen<K, V, T, D>
impl<K, V, T, D> Listen<K, V, T, D>
Sourceasync fn fetch_batch_part(
&mut self,
part: LeasedBatchPart<T>,
) -> FetchedPart<K, V, T, D> ⓘ
async fn fetch_batch_part( &mut self, part: LeasedBatchPart<T>, ) -> FetchedPart<K, V, T, D> ⓘ
Sourcepub async fn expire(self)
pub async fn expire(self)
Politely expires this listen, releasing its lease.
There is a best-effort impl in Drop for ReadHandle
to expire the
ReadHandle
held by the listen that wasn’t explicitly expired with
this method. When possible, explicit expiry is still preferred because
the Drop one is best effort and is dependant on a tokio Handle being
available in the TLC at the time of drop (which is a bit subtle). Also,
explicit expiry allows for control over when it happens.
Trait Implementations§
Auto Trait Implementations§
impl<K, V, T, D> Freeze for Listen<K, V, T, D>where
T: Freeze,
impl<K, V, T, D> !RefUnwindSafe for Listen<K, V, T, D>
impl<K, V, T, D> Send for Listen<K, V, T, D>
impl<K, V, T, D> Sync for Listen<K, V, T, D>
impl<K, V, T, D> Unpin for Listen<K, V, T, D>where
T: Unpin,
impl<K, V, T, D> !UnwindSafe for Listen<K, V, T, D>
Blanket Implementations§
Source§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
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> 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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
Source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.Source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.Source§impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
Source§fn plus_equals(&mut self, rhs: &&'a S)
fn plus_equals(&mut self, rhs: &&'a S)
std::ops::AddAssign
, for types that do not implement AddAssign
.