TurnConfig

Struct TurnConfig 

Source
pub struct TurnConfig { /* private fields */ }
Expand description

Configuration for a particular TURN server connection.

Implementations§

Source§

impl TurnConfig

Source

pub fn new( client_transport: TransportType, turn_server: Address, credentials: TurnCredentials, families: &[AddressFamily], tls_config: Option<TurnTlsConfig>, ) -> Self

Create a new TurnConfig from the provided details.

§Examples
let credentials = TurnCredentials::new("user", "pass");
let server_addr = rice_c::Address::from("127.0.0.1:3478".parse::<SocketAddr>().unwrap());
let config = TurnConfig::new(
    TransportType::Udp,
    server_addr.clone(),
    credentials.clone(),
    &[AddressFamily::IPV4],
    None,
);
assert_eq!(config.client_transport(), TransportType::Udp);
assert_eq!(config.addr(), server_addr);
// FIXME
//assert_eq!(config.credentials().username(), credentials.username());
Source

pub fn tls_config(&self) -> Option<TurnTlsConfig>

The TLS configuration to use for connecting to this TURN server.

Source

pub fn addr(&self) -> Address

The TURN server address to connect to.

Source

pub fn client_transport(&self) -> TransportType

The TransportType between the client and the TURN server.

Source

pub fn credentials(&self) -> TurnCredentials

The credentials for accessing the TURN server.

Trait Implementations§

Source§

impl Clone for TurnConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TurnConfig

Source§

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

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

impl Drop for TurnConfig

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for TurnConfig

Auto Trait Implementations§

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> 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.