Enum Signal 

#[non_exhaustive]
pub enum Signal {
    Join {
        channel: String,
    },
    Leave {
        channel: String,
    },
    Joined {
        members: Vec<String>,
        mode: Option<RoomKind>,
        role: Option<Role>,
        streamers: Option<Vec<String>>,
        turn: Option<TurnCredentials>,
        tracks: Option<Vec<TrackHint>>,
    },
    Offer {
        sdp: String,
        tracks: Option<Vec<TrackHint>>,
        chunk: Option<ChunkMeta>,
    },
    Answer {
        sdp: String,
        chunk: Option<ChunkMeta>,
    },
    Ice {
        cand: String,
        mid: Option<String>,
        mlineidx: Option<u32>,
    },
    Presence {
        member: String,
        state: PresenceState,
        kind: Option<ToggleKind>,
        role: Option<Role>,
    },
    Mic {
        state: OnOff,
    },
    Video {
        state: OnOff,
    },
    Screen {
        state: OnOff,
    },
    Hand {
        state: OnOff,
    },
    Deaf {
        state: OnOff,
    },
    Speaking,
    Silent,
    React {
        member: Option<String>,
        emoji: String,
    },
    Promote {
        target: String,
    },
    Demote {
        target: String,
    },
    Role {
        member: String,
        role: Role,
    },
    Error {
        error: Option<String>,
    },
}

One +obsidianirc/rtc signalling frame.

Every variant is one JSON object’s type. The published https://github.com/obbyworld/extensions/blob/main/voice.md documents only 9 of these, the wire carries 19, and this enum follows the wire. Outbound intent and inbound notification are modelled as distinct shapes where the wire actually distinguishes them (mic/video/screen/hand/speaking/silent/deaf versus the presence they get rebroadcast as; promote/demote versus role), rather than collapsed into one type as the published table’s prose implies.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Join

Ask to join a voice room. Client to server.

Fields

channel: String

The channel to join.

Leave

Leave a voice room. Client to server.

A reconnect should send this before rejoining: a dropped link otherwise leaves the SFU holding a dead peer for this nick, which answers a plain join with “already joined” rather than a fresh handshake.

Fields

channel: String

The channel to leave.

Joined

The server admitted us to the room. Server to client.

Fields

members: Vec<String>

Every current member’s nick.

mode: Option<RoomKind>

The room’s kind, present only for a $ channel.

role: Option<Role>

The role granted to us specifically, present only for a $ channel.

streamers: Option<Vec<String>>

Who currently publishes, for a $ channel.

turn: Option<TurnCredentials>

The TURN credentials for this call.

tracks: Option<Vec<TrackHint>>

Hints mapping media lines to the members they belong to.

Offer

An SDP offer, from either side: ours to the SFU, or the SFU renegotiating with us.

Fields

sdp: String

The offer SDP, or one slice of it when chunk is set.

tracks: Option<Vec<TrackHint>>

Track-attribution hints, carried only on chunk 0 or an unchunked offer.

chunk: Option<ChunkMeta>

Set when this frame is one of several chunks sharing an id.

Answer

An SDP answer, from either side.

Fields

sdp: String

The answer SDP, or one slice of it when chunk is set.

chunk: Option<ChunkMeta>

Set when this frame is one of several chunks sharing an id.

Ice

One ICE candidate, from either side.

Fields

cand: String

The candidate string.

mid: Option<String>

The media line it applies to.

mlineidx: Option<u32>

The media line’s index, when mid is absent.

Presence

A room or participant state change. Server to client only.

Fields

member: String

Who this is about.

state: PresenceState

What changed.

kind: Option<ToggleKind>

Which toggle, when state is PresenceState::On or PresenceState::Off.

role: Option<Role>

The role granted, when state is PresenceState::Joined in a $ room.

Mic

Our microphone toggled. Client to server; the server rebroadcasts it as presence.

Fields

state: OnOff

The new state.

Video

Our camera toggled.

Fields

state: OnOff

The new state.

Screen

Our screen share toggled.

Fields

state: OnOff

The new state.

Hand

Our raised hand toggled.

Fields

state: OnOff

The new state.

Deaf

Our deafen toggled.

A room learns that someone deafened only from this frame, so we send it the way we send mic, video, screen and hand, and the room applies the matching presence deaf-on/deaf-off like every other toggle.

Fields

state: OnOff

The new state.

Speaking

Our own voice-activity detector says we started talking.

Silent

Our own voice-activity detector says we stopped talking.

React

React with an emoji. Outbound carries no member (the sender is implicit); the server’s rebroadcast adds it.

Fields

member: Option<String>

Who reacted, present only on the inbound broadcast.

emoji: String

The emoji.

Promote

Ask to promote target to publisher, in a $ room. Client to server.

Only the room’s first streamer may do this, and self-demotion is always allowed, but that rule is enforced only by the server: nothing stops a client from sending this frame regardless.

Fields

target: String

The member to promote.

Demote

Ask to demote target back to viewer, in a $ room. Client to server.

Fields

target: String

The member to demote.

Role

The server’s authoritative answer to a promote or demote. Server to client.

Fields

member: String

Whose role changed.

role: Role

Their new role.

Error

The server rejected the last request.

Fields

error: Option<String>

A human-readable reason, when the server gave one.

Implementations

impl Signal

pub fn to_json(&self) -> String

Encode this frame as the JSON object that travels on the wire.

pub fn from_json(text: &str) -> Option<Self>

Decode one wire JSON object into a frame.

Returns None for text that is not valid JSON, an object missing a field its type requires, or a type this module does not know.

Trait Implementations

impl Clone for Signal

fn clone(&self) -> Signal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Signal

impl PartialEq for Signal

fn eq(&self, other: &Signal) -> 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 Serialize for Signal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Signal

impl TS for Signal

const DOCS: Option<&'static str>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

type WithoutGenerics = Signal

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.