Struct Realm

pub struct Realm(/* private fields */);

The REALM attribute may be present in requests and responses. It contains text that meets the grammar for “realm-value” as described in RFC3261 but without the double quotes and their surrounding white space. That is, it is an unquoted realm-value (and is therefore a sequence of qdtext or quoted-pair).

Examples

 // Create a realm attribute with an input string that meets
 // the grammar for `realm-value`
 let attr = Realm::try_from("example.org")?;
 // Realm uses the OpaqueString profile to compare strings
 assert_eq!(attr, "example.org");

 // Next input string does not meet the grammar for `realm-value`
 let result = Realm::try_from("\u{fd}\u{80}");
 assert_eq!(result.expect_err("Error expected"), StunErrorType::InvalidParam);

Implementations

impl Realm

pub fn new<S>(value: S) -> Result<Self, StunError>

where S: AsRef<str>,

Creates a Realm if the value provided meets the grammar for realm-value and can be processed using the OpaqueString profile RFC8265

pub fn as_str(&self) -> &str

Returns a slice representation of the realm value

Trait Implementations

impl AsRef<String> for Realm

fn as_ref(&self) -> &String

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for Realm

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Realm

fn clone(&self) -> Realm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Realm

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

Formats the value using the given formatter.

impl From<Realm> for StunAttribute

fn from(value: Realm) -> Self

Converts to this type from the input type.

impl Hash for Realm

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 Ord for Realm

fn cmp(&self, other: &Realm) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&str> for Realm

fn eq(&self, other: &&str) -> 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 PartialEq<Realm> for &str

fn eq(&self, other: &Realm) -> 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 PartialEq<Realm> for String

fn eq(&self, other: &Realm) -> 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 PartialEq<String> for Realm

fn eq(&self, other: &String) -> 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 PartialEq<str> for Realm

fn eq(&self, other: &str) -> 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 PartialEq for Realm

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

fn partial_cmp(&self, other: &Realm) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StunAttributeType for Realm

fn get_type() -> AttributeType

where Self: Sized,

Returns the STUN attribute type.

fn attribute_type(&self) -> AttributeType

Returns the STUN attribute type of this instance.

impl TryFrom<&String> for Realm

type Error = StunError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for Realm

type Error = StunError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Realm

type Error = StunError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Realm

impl StructuralPartialEq for Realm