Struct PublishedSourceDescriptor 

pub struct PublishedSourceDescriptor {
    source_id: PublishedSourceId,
    owner: PublishedSourceOwner,
    stream_id: UserStreamId,
    media_kind: MediaKind,
    policy: SourcePolicy,
    mid: Option<Mid>,
    encodings: Vec<SourceEncodingDescriptor>,
    selectable_encoding_indices: Vec<usize>,
}

Authoritative room-domain description of one published source.

The descriptor groups the stable source id, logical publishing user, caller stream id, media kind, source policy and negotiated source facts required by recording, diagnostics and transport projection. It deliberately excludes router producer state, socket state and packet-loop routing tables.

Invariants

A descriptor must contain at least one encoding, every encoding id must be unique and every encoding must point back to this descriptor’s source id. Self::new validates these rules so callers do not keep a parallel identity model by accident.

Fields

source_id: PublishedSourceId

owner: PublishedSourceOwner

stream_id: UserStreamId

media_kind: MediaKind

policy: SourcePolicy

mid: Option<Mid>

encodings: Vec<SourceEncodingDescriptor>

selectable_encoding_indices: Vec<usize>

Implementations

impl PublishedSourceDescriptor

pub fn new( parts: PublishedSourceDescriptorParts, ) -> Result<PublishedSourceDescriptor, SourceModelError>

Builds a source descriptor after checking the source graph invariants.

Failure means the caller assembled an invalid room-domain source and should abort the surrounding publish commit before any registry state is made authoritative.

Errors

Returns SourceModelError when the descriptor has no encodings, uses a duplicate encoding id or contains an encoding whose source id points elsewhere

pub const fn source_id(&self) -> PublishedSourceId

pub const fn owner(&self) -> &PublishedSourceOwner

pub const fn stream_id(&self) -> &UserStreamId

pub const fn media_kind(&self) -> MediaKind

pub const fn policy(&self) -> SourcePolicy

pub fn mid(&self) -> Option<&Mid>

pub fn encodings(&self) -> impl Iterator<Item = &SourceEncodingDescriptor>

pub fn selectable_encodings( &self, ) -> impl Iterator<Item = &SourceEncodingDescriptor>

Returns encodings in receiver-policy rank order.

Selection is disabled unless every encoding has a RID because packet-gate projection cannot represent the full ladder otherwise. If any maximum bitrate is known, known values sort first in ascending order. Otherwise known upload roles sort first from DegradedThumbnail to Featured. Missing sort keys and ties preserve publisher order.

pub fn selectable_encoding_count(&self) -> usize

pub fn selectable_encoding_by_rank( &self, rank: usize, ) -> Option<&SourceEncodingDescriptor>

pub fn encoding( &self, encoding_id: SourceEncodingId, ) -> Option<&SourceEncodingDescriptor>

Returns an encoding by source-encoding identity.

Missing values are normal for best-effort callers such as diagnostics or selector resolution after a source changed. Mutation paths should treat a miss as stale work and re-read authoritative room state.

Trait Implementations

impl Clone for PublishedSourceDescriptor

fn clone(&self) -> PublishedSourceDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublishedSourceDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for PublishedSourceDescriptor

fn eq(&self, other: &PublishedSourceDescriptor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PublishedSourceDescriptor

impl StructuralPartialEq for PublishedSourceDescriptor