Expand description
§live-stream
Consumer SDK for browsing and subscribing to live data feeds
served by the companion [live-feed] publisher crate. A consumer
connects to a publisher endpoint, fetches the manifest, constructs
a subscription, and receives typed batches.
Re-exports§
pub use builder::SubscriptionBuilder;pub use catalog::FeedCatalog;
Modules§
- builder
- Builder for
SubscriptionDescriptor. - catalog
- Browseable view over a parsed manifest.
Structs§
- Capabilities
- What the publisher is willing to do server-side when accepting a subscription.
- Endpoint
- Identifies where a consumer should connect to read a feed.
- Feed
Descriptor - Single named live feed, as advertised by a publisher.
- Feed
Manifest - Snapshot of everything a publisher currently exposes.
- Field
Spec - One field in a
WireSchema. - Sampling
- Optional sampling policy that can be applied server-side.
- Subscribe
Ack - Successful subscription. Tells the consumer where to read from and what to expect.
- Subscribe
Error - Reason a subscription was refused.
- Subscription
Descriptor - Request to open one feed.
- Transport
Preference - Ordered transport preference list, most-preferred first.
- Wire
Schema - Ordered list of fields that make up a feed’s schema.
Enums§
- Error
- Filter
Expr - Server-side filter expression.
- Format
Preference - Format the publisher will emit batches in once a subscription is accepted.
- Subscribe
Error Code - Subscribe
Response - Publisher’s reply to a
SubscriptionDescriptor. - Transport
Tag - One of the transports a feed can be exposed over.
Constants§
- CONTROL_
TAG_ FEEDS - Control-channel tag used by a consumer to request the manifest.
- CONTROL_
TAG_ SUBSCRIBE - Control-channel tag used by a consumer to open a subscription.
- PROTOCOL_
VERSION - Wire protocol version negotiated between publishers and consumers.