Struct DataChannelOptions

pub struct DataChannelOptions {
    pub ordered: Option<bool>,
    pub max_packet_life_time: Option<u16>,
    pub max_retransmits: Option<u16>,
    pub protocol: Option<String>,
    pub negotiated: Option<u16>,
}

DataChannelOptions can be used to configure properties of the underlying channel such as data reliability.

Fields

ordered: Option<bool>

ordered indicates if data is allowed to be delivered out of order. The default value of true, guarantees that data will be delivered in order.

max_packet_life_time: Option<u16>

max_packet_life_time limits the time (in milliseconds) during which the channel will transmit or retransmit data if not acknowledged. This value may be clamped if it exceeds the maximum value supported.

max_retransmits: Option<u16>

max_retransmits limits the number of times a channel will retransmit data if not successfully delivered. This value may be clamped if it exceeds the maximum value supported.

protocol: Option<String>

protocol describes the subprotocol name used for this channel.

negotiated: Option<u16>

negotiated describes if the data channel is created by the local peer or the remote peer. The default value of None tells the user agent to announce the channel in-band and instruct the other peer to dispatch a corresponding DataChannel. If set to Some(id), it is up to the application to negotiate the channel and create an DataChannel with the same id at the other peer.

Trait Implementations

impl Clone for DataChannelOptions

fn clone(&self) -> DataChannelOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataChannelOptions

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

Formats the value using the given formatter.

impl Default for DataChannelOptions

fn default() -> DataChannelOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DataChannelOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DataChannelOptions> for RTCDataChannelInit

fn from(value: DataChannelOptions) -> Self

Converts to this type from the input type.

impl Hash for DataChannelOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DataChannelOptions

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DataChannelOptions

impl StructuralPartialEq for DataChannelOptions