Skip to main content

RTCIceTransportPolicy

Enum RTCIceTransportPolicy 

Source
pub enum RTCIceTransportPolicy {
    Unspecified = 0,
    All = 1,
    Relay = 2,
}
Expand description

ICE transport policy controlling which candidate types are used for connectivity.

This policy determines which ICE candidates the peer connection will use and gather during the connection establishment process. It’s primarily used for privacy control and network security requirements.

§Privacy Considerations

  • All - Exposes local IP addresses (host candidates) and public IPs (srflx)
  • Relay - Hides all IP addresses, only TURN server address visible (privacy mode)

§Examples

§Standard Configuration (All Candidates)

use rtc::peer_connection::configuration::{RTCConfigurationBuilder, RTCIceTransportPolicy};

// Use all candidates for best connectivity (default)
let config = RTCConfigurationBuilder::new()
    .with_ice_transport_policy(RTCIceTransportPolicy::All)
    .build();

§Privacy Mode (Relay Only)

use rtc::peer_connection::configuration::{RTCConfigurationBuilder, RTCIceTransportPolicy};
use rtc::peer_connection::configuration::RTCIceServer;

// Only use TURN relays to hide IP addresses
let config = RTCConfigurationBuilder::new()
    .with_ice_servers(vec![
        RTCIceServer {
            urls: vec!["turn:turn.example.com:3478".to_string()],
            username: "user".to_string(),
            credential: "password".to_string(),
            ..Default::default()
        },
    ])
    .with_ice_transport_policy(RTCIceTransportPolicy::Relay)
    .build();

§Specifications

Variants§

§

Unspecified = 0

Unspecified - not a valid policy, used as default value

§

All = 1

Use all types of ICE candidates (recommended for best connectivity).

Gathers and uses:

  • Host candidates - Local IP addresses
  • Server reflexive (srflx) - Public IP from STUN servers
  • Relay candidates - TURN server addresses

This provides the best chance of establishing a connection but may expose local and public IP addresses.

Use when: Normal operation, prioritizing connectivity over privacy

§

Relay = 2

Only use relay candidates from TURN servers (privacy mode).

Only gathers and uses relay candidates obtained through TURN servers. This hides the client’s IP addresses from the remote peer but requires a TURN server and may reduce connection quality.

Use when: Privacy is critical, IP addresses must be hidden

Requirements: Must have TURN servers configured

Trait Implementations§

Source§

impl Clone for RTCIceTransportPolicy

Source§

fn clone(&self) -> RTCIceTransportPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RTCIceTransportPolicy

Source§

impl Debug for RTCIceTransportPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RTCIceTransportPolicy

Source§

fn default() -> RTCIceTransportPolicy

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RTCIceTransportPolicy

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for RTCIceTransportPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for RTCIceTransportPolicy

Source§

impl From<&str> for RTCIceTransportPolicy

takes a string and converts it to ICETransportPolicy

Source§

fn from(raw: &str) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for RTCIceTransportPolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for RTCIceTransportPolicy

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RTCIceTransportPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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
Source§

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

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V