Struct IngestContext 

pub struct IngestContext { /* private fields */ }

The ergonomic, cloneable handle a protocol worker uses to reach the engine bus, handed to every InboundProtocol::serve call.

It hides the PublishRegistry trait object behind a small, stable surface: claim a stream for publishing (open_publish), or reach the underlying registry for advanced flows (registry). Cloning is cheap (an Arc bump) — share it freely across per-connection tasks.

Implementations

impl IngestContext

pub fn new(registry: Arc<dyn PublishRegistry>) -> Self

Wrap a publish registry. The engine constructs this for you; tests and embedders can build one directly from any PublishRegistry (e.g. an Arc<Engine>).

pub async fn open_publish(&self, key: StreamKey) -> Result<PublishSession>

Claim key for publishing, returning an RAII PublishSession.

Frames published through the returned session flow into the lock-free broadcast fan-out, the keyframe-anchored GOP cache (for instant-start replay), and the live QoS counters — exactly as a native handler’s frames do. Fails with StreamAlreadyPublishing on a live duplicate or PublisherLimitReached at capacity.

pub async fn open_publish_checked( &self, key: StreamKey, creds: &Credentials, ) -> Result<PublishSession>

Like open_publish, but enforces the registry’s admission policy (PublishRegistry::start_publish_checked) against creds first — protocol handlers that carry a credential (SRT passphrase/ streamid token, a publish token) should use this so the publish is gated before any media is accepted.

pub fn registry(&self) -> &Arc<dyn PublishRegistry>

The underlying publish registry, for flows not covered by open_publish.

Trait Implementations

impl Clone for IngestContext

fn clone(&self) -> IngestContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.