Crate sea_streamer_types
source ·Expand description
sea-streamer-types
: Traits & Types
This crate defines all the traits and types for the SeaStreamer API, but does not provide any implementation.
Modules
- Re-export types from related libraries
Structs
- Used to identify a group of consumers.
- Used to identify a consumer within a group.
- Metadata associated with a message.
- The payload of a message.
- Identifies a shard. Aka. partition.
- It uses an
Arc
to hold the bytes, so is cheap to clone. - Identifies a stream. Aka. topic.
- Streamer URI with stream key(s).
- URI of Streaming Server. If this is a cluster, there can be multiple nodes.
- A
PrimitiveDateTime
with aUtcOffset
.
Enums
- Bytes or Str. Being an
str
means the data is UTF-8 valid. - Mode of stream consumption.
- JsonErr
json
Errors that may happen when processing JSON - Identifies a position in a stream.
- Common errors that may occur.
- Errors that may happen when handling StreamKey
- Errors that may happen when parsing stream URL
Constants
- Maximum string length of a stream key.
- Reserved by SeaStreamer. Avoid using this as StreamKey.
- Canonical display format for Timestamp.
Traits
- Common interface of byte containers.
- Common options when connecting to a streamer.
- Common interface of consumers, to be implemented by all backends.
- Common options of a Consumer.
- Types that be converted into
BytesOrStr
. - Common interface of messages, to be implemented by all backends.
- Common interface of producers, to be implemented by all backends.
- Common options of a Producer.
- Common interface of streamer clients.
Functions
- Returns true if this character can be used in a stream key.
- Function to construct a
StreamErr::Runtime
error variant.
Type Aliases
- Delivery receipt.
- The tuple (StreamKey, ShardId, SeqNo) uniquely identifies a message. Aka. offset.
- Type alias of the
Result
type specific tosea-streamer
.