Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

A Kafka client backed by a BrokerPool.

Construct via Client::builder.

Cloning a Client is cheap — it shares the underlying BrokerPool via an Arc and the connection options via a value clone.

Implementations§

Source§

impl Client

Source

pub async fn start( bootstrap: String, client_id: String, connect_timeout: Duration, request_timeout: Duration, security: Option<ClientSecurity>, ) -> Result<Self, ClientError>

Build a Client pointed at the given bootstrap address.

Source

pub fn builder() -> ClientStartBuilder

Build a Client pointed at the given bootstrap address.

Source§

impl Client

Source

pub async fn send<R: ProtocolRequest>( &self, req: R, ) -> Result<R::Response, ClientError>

Send a request to the bootstrap broker (or any cached open connection).

Source

pub fn knows_broker(&self, broker_id: i32) -> bool

Whether the pool knows a dialable address for broker_id (learned via refresh_metadata, port not 0). Lets a caller choose between broker routing and the bootstrap send without a speculative connect.

Source

pub fn broker(&self, broker_id: i32) -> BrokerHandle<'_>

Return a BrokerHandle that routes requests to a specific broker by id.

The broker must have been registered via refresh_metadata first.

Source

pub async fn refresh_metadata(&self) -> Result<MetadataResponse, ClientError>

Send a default MetadataRequest, parse the broker list from the response, refresh the pool’s address registry, and return the typed response.

Source

pub async fn offset_for_leader_epoch( &self, topic: &str, partition: i32, current_leader_epoch: i32, leader_epoch: i32, ) -> Result<EpochEndOffset, ClientError>

Send a single-partition OffsetForLeaderEpoch (api_key=23) via the bootstrap connection. Thin wrapper over the free offset_for_leader_epoch helper used by the consumer’s KIP-320 position-validation pass; Client does not otherwise expose its connection, so this borrows the same bootstrap connection send uses.

§Errors

Transport / version-negotiation failure, or a partition not present in the response.

Source

pub async fn offset_for_leader_epoch_on( &self, broker_id: i32, topic: &str, partition: i32, current_leader_epoch: i32, leader_epoch: i32, ) -> Result<EpochEndOffset, ClientError>

Send a single-partition OffsetForLeaderEpoch (api_key=23) to a specific broker by id, via BrokerPool::get. Mirrors offset_for_leader_epoch but targets the partition leader instead of the bootstrap connection — KIP-320 requires the validation RPC reach the partition leader, which is the only replica with the authoritative epoch→end-offset history.

The broker must already be in the pool’s registry (populated by refresh_metadata).

§Errors

Disconnected if broker_id is not in the registry; transport / version-negotiation failure; or a partition not present in the response.

Source

pub fn close(self)

Close the client and all pooled connections.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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