pub struct KafkaStreams { /* private fields */ }Expand description
A managed Kafka Streams runtime.
It joins a streams group, runs the assigned tasks in the at-least-once order fetch → process → produce → commit, and reacts to rebalances.
Implementations§
Source§impl KafkaStreams
impl KafkaStreams
Sourcepub async fn start(
bootstrap: String,
application_id: String,
topology: BuiltTopology,
poll_interval: Duration,
commit_interval: Duration,
rebalance_timeout: Duration,
join_retry_backoff: Duration,
leave_heartbeat_timeout: Duration,
store_backend: StoreBackend,
processing_guarantee: ProcessingGuarantee,
broker_dns_timeout: ClientDnsTimeout,
client_dispatch_queue_capacity: usize,
client_frame_max: ByteSize,
fetch_min: ByteSize,
cache_max_bytes: ByteSize,
interactive_query_queue_capacity: StreamsInteractiveQueryQueueCapacity,
barrier: Option<BarrierAlignment>,
) -> Result<Self, StreamsClientError>
pub async fn start( bootstrap: String, application_id: String, topology: BuiltTopology, poll_interval: Duration, commit_interval: Duration, rebalance_timeout: Duration, join_retry_backoff: Duration, leave_heartbeat_timeout: Duration, store_backend: StoreBackend, processing_guarantee: ProcessingGuarantee, broker_dns_timeout: ClientDnsTimeout, client_dispatch_queue_capacity: usize, client_frame_max: ByteSize, fetch_min: ByteSize, cache_max_bytes: ByteSize, interactive_query_queue_capacity: StreamsInteractiveQueryQueueCapacity, barrier: Option<BarrierAlignment>, ) -> Result<Self, StreamsClientError>
§Errors
Returns an error when configuration is invalid, protocol encoding fails, the broker rejects the request, or transport I/O fails.
Source§impl KafkaStreams
impl KafkaStreams
Sourcepub async fn key_value_store<K, V>(
&self,
name: impl Into<String>,
key_serde: impl Serde<K> + 'static,
value_serde: impl Serde<V> + 'static,
) -> Result<ReadOnlyKeyValueStore<K, V>, StreamsClientError>
pub async fn key_value_store<K, V>( &self, name: impl Into<String>, key_serde: impl Serde<K> + 'static, value_serde: impl Serde<V> + 'static, ) -> Result<ReadOnlyKeyValueStore<K, V>, StreamsClientError>
A read-only view of the local KeyValue state store name, for
interactive queries.
It returns an error when this instance holds no assignment for the store, or when the store is of a different kind.
§Errors
Returns an error when configuration is invalid, protocol encoding fails, the broker rejects the request, or transport I/O fails.
Sourcepub async fn window_store<K, V>(
&self,
name: impl Into<String>,
key_serde: impl Serde<K> + 'static,
value_serde: impl Serde<V> + 'static,
) -> Result<ReadOnlyWindowStore<K, V>, StreamsClientError>
pub async fn window_store<K, V>( &self, name: impl Into<String>, key_serde: impl Serde<K> + 'static, value_serde: impl Serde<V> + 'static, ) -> Result<ReadOnlyWindowStore<K, V>, StreamsClientError>
A read-only view of the local Window state store name.
§Errors
Returns an error when configuration is invalid, protocol encoding fails, the broker rejects the request, or transport I/O fails.
Sourcepub async fn session_store<K, V>(
&self,
name: impl Into<String>,
key_serde: impl Serde<K> + 'static,
value_serde: impl Serde<V> + 'static,
) -> Result<ReadOnlySessionStore<K, V>, StreamsClientError>
pub async fn session_store<K, V>( &self, name: impl Into<String>, key_serde: impl Serde<K> + 'static, value_serde: impl Serde<V> + 'static, ) -> Result<ReadOnlySessionStore<K, V>, StreamsClientError>
A read-only view of the local Session state store name.
§Errors
Returns an error when configuration is invalid, protocol encoding fails, the broker rejects the request, or transport I/O fails.
Sourcepub async fn query<Q: Query>(
&self,
req: StateQuery<Q>,
) -> StateQueryResult<Q::Result>
pub async fn query<Q: Query>( &self, req: StateQuery<Q>, ) -> StateQueryResult<Q::Result>
Run an IQv2 query against the locally assigned partitions and return
one QueryResult per partition. The method takes no serdes, because the
store supplies its own.
Sourcepub async fn restore_to_epoch(
&self,
epoch: i64,
) -> Result<BarrierCut, StreamsClientError>
pub async fn restore_to_epoch( &self, epoch: i64, ) -> Result<BarrierCut, StreamsClientError>
Rewinds every active task to the cut of epoch.
Each task’s stores become the snapshot taken at that cut, and every source partition the cut names seeks to its marker offset. Processing then replays from the cut.
§Errors
Returns an error when the app names no barrier group, when the group has
no complete cut at epoch, when a task has no snapshot at that epoch, or
when the supervisor has stopped.
Sourcepub async fn restore_to_latest_cut(
&self,
) -> Result<BarrierCut, StreamsClientError>
pub async fn restore_to_latest_cut( &self, ) -> Result<BarrierCut, StreamsClientError>
Rewinds every active task to the complete cut with the highest epoch, as
restore_to_epoch does for a named epoch.
§Errors
Returns an error when the app names no barrier group, when the group has no complete cut, when a task has no snapshot at that cut, or when the supervisor has stopped.
Auto Trait Implementations§
impl Freeze for KafkaStreams
impl RefUnwindSafe for KafkaStreams
impl Send for KafkaStreams
impl Sync for KafkaStreams
impl Unpin for KafkaStreams
impl UnsafeUnpin for KafkaStreams
impl UnwindSafe for KafkaStreams
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
§impl<K, Q> Comparable<Q> for K
impl<K, Q> Comparable<Q> for K
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> DowncastSend for T
impl<T> DowncastSend for T
§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<K, Q> Equivalent<Q> for K
impl<K, Q> Equivalent<Q> for K
§fn equivalent(&self, key: &Q) -> bool
fn equivalent(&self, key: &Q) -> bool
key and return true if they are equal.impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> Fruit for Twhere
T: Send + Downcast,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§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>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§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);