Struct librice::stun::attribute::UseCandidate

pub struct UseCandidate {}

The UseCandidate Attribute

Implementations

impl UseCandidate

pub fn new() -> Self

Create a new UseCandidate Attribute

Examples

let _use_candidate = UseCandidate::new();

Examples found in repository

src/stun/attribute.rs (line 1145)

    fn default() -> Self {
        UseCandidate::new()
    }

src/conncheck.rs (line 171)

    fn generate_stun_request(
        conncheck: Arc<ConnCheck>,
        username: String,
        controlling: bool,
        tie_breaker: u64,
    ) -> Result<StunRequest, StunError> {
        let mut msg = Message::new_request(BINDING);

        // XXX: this needs to be the priority as if the candidate was peer-reflexive
        msg.add_attribute(Priority::new(conncheck.pair.local.priority))?;
        if controlling {
            msg.add_attribute(IceControlling::new(tie_breaker))?;
        } else {
            msg.add_attribute(IceControlled::new(tie_breaker))?;
        }
        if conncheck.nominate {
            msg.add_attribute(UseCandidate::new())?;
        }
        msg.add_attribute(Username::new(&username)?)?;
        msg.add_message_integrity(&conncheck.agent.local_credentials().unwrap())?;
        msg.add_fingerprint()?;

        let to = conncheck.pair.remote.address;
        conncheck.agent.stun_request_transaction(&msg, to)?.build()
    }

Trait Implementations

impl Attribute for UseCandidate

fn get_type(&self) -> AttributeType

Retrieve the AttributeType of an Attribute

fn length(&self) -> u16

Retrieve the length of an Attribute. This is not the padded length as stored in a Message

fn to_raw(&self) -> RawAttribute

Convert an Attribute to a RawAttribute

fn from_raw(raw: &RawAttribute) -> Result<Self, StunParseError>

Convert an Attribute from a RawAttribute

impl Debug for UseCandidate

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

Formats the value using the given formatter.

impl Default for UseCandidate

fn default() -> Self

Returns the “default value” for a type.

impl Display for UseCandidate

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

Formats the value using the given formatter.

impl From<UseCandidate> for RawAttribute

fn from(f: UseCandidate) -> Self

Converts to this type from the input type.

impl TryFrom<&RawAttribute> for UseCandidate

type Error = StunParseError

The type returned in the event of a conversion error.

fn try_from(value: &RawAttribute) -> Result<Self, Self::Error>

Performs the conversion.