Skip to main content

ControlMessage

Enum ControlMessage

pub enum ControlMessage {
Show 22 variants    Join {
        peer_id: PeerId,
        display_name: Option<String>,
    },
    Hello {
        peer_id: PeerId,
        public_key: Vec<u8>,
        capabilities: Capabilities,
        candidates: Vec<SocketAddr>,
    },
    IceCandidates {
        peer_id: PeerId,
        session: SessionId,
        candidates: Vec<IceCandidate>,
    },
    IceCheck {
        session: SessionId,
        tie_breaker: u64,
        candidate: IceCandidate,
    },
    IceCheckAck {
        session: SessionId,
        candidate: IceCandidate,
    },
    KeyInit {
        session: SessionId,
        eph_pub_x25519: [u8; 32],
        sig_ed25519: Vec<u8>,
    },
    KeyResp {
        session: SessionId,
        eph_pub_x25519: [u8; 32],
        sig_ed25519: Vec<u8>,
    },
    EncryptedReady {
        session: SessionId,
        alg: u8,
    },
    Leave {
        peer_id: PeerId,
    },
    PeerState {
        peer_id: PeerId,
        relay_capable: bool,
    },
    Chat(ChatMessage),
    Ping {
        nonce: u64,
        sent_at_ms: u64,
    },
    Pong {
        nonce: u64,
        sent_at_ms: u64,
    },
    Auth {
        token: Vec<u8>,
    },
    RouteInfo {
        from: PeerId,
        to: PeerId,
        relayed: bool,
    },
    Capabilities(Capabilities),
    CapabilitiesUpdate(Capabilities),
    PeerList {
        peers: Vec<PeerInfo>,
    },
    Call(CallControl),
    Group(GroupControl),
    E2eeInit {
        session: SessionId,
        from: PeerId,
        public_key: [u8; 32],
        signature: Vec<u8>,
    },
    E2eeResp {
        session: SessionId,
        from: PeerId,
        public_key: [u8; 32],
        signature: Vec<u8>,
    },
}

Expand description

Control plane messages exchanged over the Control stream.

Variants§

Join

Fields

§peer_id: PeerId

§display_name: Option<String>

Hello

Fields

§peer_id: PeerId

§public_key: Vec<u8>

§capabilities: Capabilities

§candidates: Vec<SocketAddr>

IceCandidates

Fields

§peer_id: PeerId

§session: SessionId

§candidates: Vec<IceCandidate>

IceCheck

Fields

§session: SessionId

§tie_breaker: u64

§candidate: IceCandidate

IceCheckAck

Fields

§session: SessionId

§candidate: IceCandidate

KeyInit

Fields

§session: SessionId

§eph_pub_x25519: [u8; 32]

§sig_ed25519: Vec<u8>

KeyResp

Fields

§session: SessionId

§eph_pub_x25519: [u8; 32]

§sig_ed25519: Vec<u8>

EncryptedReady

Fields

§session: SessionId

§alg: u8

Leave

Fields

§peer_id: PeerId

PeerState

Fields

§peer_id: PeerId

§relay_capable: bool

Chat(ChatMessage)

Ping

Fields

§nonce: u64

§sent_at_ms: u64

Pong

Fields

§nonce: u64

§sent_at_ms: u64

Auth

Fields

§token: Vec<u8>

RouteInfo

Fields

§from: PeerId

§to: PeerId

§relayed: bool

Capabilities(Capabilities)

CapabilitiesUpdate(Capabilities)

PeerList

Fields

§peers: Vec<PeerInfo>

Call(CallControl)

Group(GroupControl)

E2eeInit

Fields

§session: SessionId

§from: PeerId

§public_key: [u8; 32]

§signature: Vec<u8>

E2eeResp

Fields

§session: SessionId

§from: PeerId

§public_key: [u8; 32]

§signature: Vec<u8>

Trait Implementations§

impl Clone for ControlMessage

fn clone(&self) -> ControlMessage

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ControlMessage

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ControlMessage

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for ControlMessage

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for ControlMessage

impl RefUnwindSafe for ControlMessage

impl Send for ControlMessage

impl Sync for ControlMessage

impl Unpin for ControlMessage

impl UnwindSafe for ControlMessage

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,