rust-pubsub-lib

rust-pubsub-lib provides a shared abstraction for publishing to, snapshotting from, and subscribing to broker-backed topics from Rust applications. It hides backend-specific connection details behind a small set of async traits so application code can stay focused on message handling instead of transport setup.

Interface

The primary abstractions provided by this library are the Publisher, Snapshot, and Subscriber traits.

• Publisher asynchronously sends a message to a configured topic.
• Snapshot reads the currently available messages for a topic in one operation.
• Subscriber yields a stream of messages as they arrive.
• Message describes the message shape used across all backends.

The library also provides concrete message helpers:

• ByteMessage for raw byte payloads.
• StringMessage for UTF-8-oriented payloads, using lossy decoding when byte input is not valid UTF-8.

Feature selection

Select one or more crate features depending on the broker backend your application uses.

• kafka: enables kafka_impl with Kafka-backed implementations of Publisher, Snapshot, and Subscriber.
• redis-pubsub: enables redis_impls::pubsub with Redis pub/sub implementations of Publisher and Subscriber.
• redis-stream: enables redis_impls::stream with Redis Stream implementations of Publisher, Snapshot, and Subscriber.
• testing-utils: enables backend-specific test harness helpers such as kafka_impl::testing_utils for tests that exercise broker-facing code.

Required environment variables

The following environment variables are required for Kafka-backed behavior:

• KAFKA_CONNECTION_SECONDS: controls the timeout used by Kafka operations in get_kafka_timeout_val().

Redis-backed implementations do not currently require a crate-specific environment variable, but they do require a valid Redis connection URI to be passed to Publisher::new(), Snapshot::get(), or Subscriber::new().

Documentation

Generate the crate documentation locally with cargo doc --all-features and open the output from target/doc/. The most important API entry points are documented in src/lib.rs, with backend-specific details under src/kafka_impl/mod.rs and src/redis_impls/mod.rs.

Development

The following packages must be present on the host machine when building this library:

• cmake
• libcurl4-openssl-dev
• libsasl2-dev
• zlib

The configured Dev Container in .devcontainer/ has the necessary tools to build without additional installation.