Struct Credentials 

pub struct Credentials { /* private fields */ }

The short-term credentials for a stream: ice-ufrag and ice-pwd (RFC 8839 §5.4).

The two travel together because §5.4 requires both for every data stream, whether they are written at session or media level, and because RFC 8445 §7.1.2 keys a connectivity check’s MESSAGE-INTEGRITY on the password that goes with a particular fragment. A type carrying one without the other would be a credential that cannot authenticate anything.

The fields are private so the length bounds cannot be lost after construction: the send and receive bounds differ, and which one applied is a property of how the value arrived.

Implementations

impl Credentials

pub const MAX_SENT_LEN: usize = 32

The longest ice-ufrag or ice-pwd §5.4 permits sipx to send.

pub const MAX_ACCEPTED_LEN: usize = 256

The longest either that sipx must accept on receive.

pub const MIN_UFRAG_LEN: usize = 4

The shortest ice-ufrag the grammar admits.

pub const MIN_PWD_LEN: usize = 22

The shortest ice-pwd the grammar admits.

pub fn new(ufrag: impl Into<String>, pwd: impl Into<String>) -> Option<Self>

Credentials sipx will put in an offer or answer.

None when either value is outside what §5.4 permits to be sent: “MUST NOT be longer than 32 characters when sending, but an implementation MUST accept up to 256 characters when receiving”. The asymmetry is why this is a different constructor from Credentials::received rather than a flag — sending 200 characters is a defect, and receiving them is Tuesday.

pub fn received( ufrag: impl Into<String>, pwd: impl Into<String>, ) -> Option<Self>

Credentials read from a peer’s description.

pub fn ufrag(&self) -> &str

The username fragment.

pub fn pwd(&self) -> &str

The password.

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl PartialEq for Credentials

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

impl StructuralPartialEq for Credentials