Struct mz_persist_client::read::Listen

pub struct Listen<K, V, T, D>where
    T: Timestamp + Lattice + Codec64,
    K: Debug + Codec,
    V: Debug + Codec,
    D: Semigroup + Codec64 + Send + Sync,
{ /* private fields */ }

Expand description

An ongoing subscription of updates to a shard.

Implementations§

impl<K, V, T, D> Listen<K, V, T, D>
where K: Debug + Codec, V: Debug + Codec, T: Timestamp + Lattice + Codec64, D: Semigroup + Codec64 + Send + Sync,

pub fn frontier(&self) -> &Antichain<T>

An exclusive upper bound on the progress of this Listen.

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.

impl<K, V, T, D> Listen<K, V, T, D>
where K: Debug + Codec + Default, V: Debug + Codec + Default, T: Timestamp + Lattice + Codec64, D: Semigroup + Codec64 + Send + Sync,

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!

pub fn into_stream( self ) -> impl Stream<Item = ListenEvent<T, ((Result<K, String>, Result<V, String>), T, D)>>

Convert listener into futures::Stream

impl<K, V, T, D> Listen<K, V, T, D>
where K: Debug + Codec, V: Debug + Codec, T: Timestamp + Lattice + Codec64, D: Semigroup + Codec64 + Send + Sync,

pub async fn expire(self)

Politely expires this listen, releasing its lease.

There is a best-effort impl in Drop to expire a 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§

impl<K, V, T, D> Debug for Listen<K, V, T, D>
where T: Timestamp + Lattice + Codec64 + Debug, K: Debug + Codec + Debug, V: Debug + Codec + Debug, D: Semigroup + Codec64 + Send + Sync + Debug,

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, U> CastInto<U> for T
where U: CastFrom<T>,

fn cast_into(self) -> U

Performs the cast.

impl<R, O, T> CopyOnto<ConsecutiveOffsetPairs<R, O>> for T
where R: Region<Index = (usize, usize)>, O: OffsetContainer<usize>, T: CopyOnto<R>,

fn copy_onto( self, target: &mut ConsecutiveOffsetPairs<R, O> ) -> <ConsecutiveOffsetPairs<R, O> as Region>::Index

Copy self into the target container, returning an index that allows to look up the corresponding read item.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<P, R> ProtoType<R> for P
where R: RustType<P>,

fn into_rust(self) -> Result<R, TryFromProtoError>

See RustType::from_proto.

fn from_rust(rust: &R) -> P

See RustType::into_proto.

impl<R, T> PushInto<FlatStack<R>> for T
where R: Region + Clone + 'static, T: CopyOnto<R>,

fn push_into(self, target: &mut FlatStack<R>)

Push self into the target container.

impl<T> PushInto<Vec<T>> for T

fn push_into(self, target: &mut Vec<T>)

Push self into the target container.

impl<T> Same for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more