Struct SubscriptionConfig

pub struct SubscriptionConfig {
    pub id: Uuid,
    pub stream_name: SubscriptionName,
    pub frequency: Duration,
}

A configuration for a subscription to a stream of events.

Fields

id: Uuid

A unique identifier for the subscription. See SubscriptionConfig::stream_id for a fully qualified identifier.

stream_name: SubscriptionName

The name of the stream that the subscription is listening to. This is the target stream that the subscription is reading from, and is combined with the id to form the fully qualified stream id.

frequency: Duration

The frequency at which the subscription should poll the target stream for new events. Used for throttling the stream, so that it doesn’t consume too many resources or hammer any external services.

Implementations

impl SubscriptionConfig

pub fn new(id: Uuid, stream_name: SubscriptionName, frequency: Duration) -> Self

Create a new subscription configuration.

pub fn stream_id(&self) -> String

A unique identifier for the subscription.

pub fn subscription<Repo>( &self, repo: &Repo, ) -> Result<Subscription<Repo>, String>

where Repo: EventRepo + Clone + Send + Sync + 'static,

Resumes a subscription with the given id.

pub fn stream<Repo>(&self, repo: &Repo) -> impl Stream<Item = Frame>

where Repo: EventRepo + Clone + Send + Sync + 'static,

Construct a throttled stream of frames from the subscription.

pub fn worker(&self, worker: SubscriptionWorker) -> impl Stream<Item = Frame>

Start a worker stream with the given service.

Trait Implementations

impl Clone for SubscriptionConfig

fn clone(&self) -> SubscriptionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: AsRef<str>> From<T> for SubscriptionConfig

fn from(inner: T) -> Self

Converts to this type from the input type.