Skip to main content

Client

Struct Client 

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

Rivven client for connecting to a Rivven server

Implementations§

Source§

impl Client

Source

pub async fn connect(addr: &str) -> Result<Self>

Connect to a Rivven server (plaintext)

Source

pub async fn authenticate( &mut self, username: &str, password: &str, ) -> Result<AuthSession>

Authenticate with simple username/password

This uses a simple plaintext password protocol. For production use over untrusted networks, prefer authenticate_scram() or use TLS.

Source

pub async fn authenticate_scram( &mut self, username: &str, password: &str, ) -> Result<AuthSession>

Authenticate using SCRAM-SHA-256 (secure challenge-response)

SCRAM-SHA-256 (RFC 5802/7677) provides:

  • Password never sent over the wire
  • Mutual authentication (server proves it knows password too)
  • Protection against replay attacks
§Example
let mut client = Client::connect("127.0.0.1:9092").await?;
let session = client.authenticate_scram("alice", "password123").await?;
println!("Session: {} (expires in {}s)", session.session_id, session.expires_in);
Source

pub async fn publish( &mut self, topic: impl Into<String>, value: impl Into<Bytes>, ) -> Result<u64>

Publish a message to a topic

Source

pub async fn publish_with_key( &mut self, topic: impl Into<String>, key: Option<impl Into<Bytes>>, value: impl Into<Bytes>, ) -> Result<u64>

Publish a message with a key to a topic

Source

pub async fn publish_to_partition( &mut self, topic: impl Into<String>, partition: u32, key: Option<impl Into<Bytes>>, value: impl Into<Bytes>, ) -> Result<u64>

Publish a message to a specific partition

Source

pub async fn consume( &mut self, topic: impl Into<String>, partition: u32, offset: u64, max_messages: usize, ) -> Result<Vec<MessageData>>

Consume messages from a topic partition

Source

pub async fn create_topic( &mut self, name: impl Into<String>, partitions: Option<u32>, ) -> Result<u32>

Create a new topic

Source

pub async fn list_topics(&mut self) -> Result<Vec<String>>

List all topics

Source

pub async fn delete_topic(&mut self, name: impl Into<String>) -> Result<()>

Delete a topic

Source

pub async fn commit_offset( &mut self, consumer_group: impl Into<String>, topic: impl Into<String>, partition: u32, offset: u64, ) -> Result<()>

Commit consumer offset

Source

pub async fn get_offset( &mut self, consumer_group: impl Into<String>, topic: impl Into<String>, partition: u32, ) -> Result<Option<u64>>

Get consumer offset

Source

pub async fn get_offset_bounds( &mut self, topic: impl Into<String>, partition: u32, ) -> Result<(u64, u64)>

Get earliest and latest offsets for a topic partition

Returns (earliest, latest) where:

  • earliest: First available offset (messages before this are deleted/compacted)
  • latest: Next offset to be assigned (one past the last message)
Source

pub async fn get_metadata( &mut self, topic: impl Into<String>, ) -> Result<(String, u32)>

Get topic metadata

Source

pub async fn ping(&mut self) -> Result<()>

Ping the server

Source

pub async fn register_schema( &mut self, subject: impl Into<String>, schema: impl Into<String>, ) -> Result<i32>

Register a schema

Source

pub async fn get_schema(&mut self, id: i32) -> Result<String>

Get a schema

Source

pub async fn list_groups(&mut self) -> Result<Vec<String>>

List all consumer groups

Source

pub async fn describe_group( &mut self, consumer_group: impl Into<String>, ) -> Result<HashMap<String, HashMap<u32, u64>>>

Describe a consumer group (get all committed offsets)

Source

pub async fn delete_group( &mut self, consumer_group: impl Into<String>, ) -> Result<()>

Delete a consumer group

Source

pub async fn get_offset_for_timestamp( &mut self, topic: impl Into<String>, partition: u32, timestamp_ms: i64, ) -> Result<Option<u64>>

Get the first offset with timestamp >= the given timestamp

§Arguments
  • topic - The topic name
  • partition - The partition number
  • timestamp_ms - Timestamp in milliseconds since Unix epoch
§Returns
  • Some(offset) - The first offset with message timestamp >= timestamp_ms
  • None - No messages found with timestamp >= timestamp_ms

Auto Trait Implementations§

§

impl !Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

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<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<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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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