Struct OwnedMxcUri 

pub struct OwnedMxcUri { /* private fields */ }

Owned variant of MxcUri

Inner representation

By default, this type uses a Box<str> internally. The inner representation can be selected at compile time by using one of the following supported values:

• Arc – Use an Arc<str>.

The selected value can be set by using the ruma_identifiers_storage compile-time cfg setting. This setting can be configured using the RUSTFLAGS environment variable at build time, like this:

RUSTFLAGS="--cfg ruma_identifiers_storage=\"{value}\""

Or in .cargo/config.toml:

# General setting for all targets, overridden by per-target `rustflags` setting if set.
[build]
rustflags = ["--cfg", "ruma_identifiers_storage=\"{value}\""]

# Per-target setting.
[target.<triple/cfg>]
rustflags = ["--cfg", "ruma_identifiers_storage=\"{value}\""]

This setting can also be configured using the RUMA_IDENTIFIERS_STORAGE environment variable at compile time, which has the benefit of not requiring to re-compile the whole dependency chain when the value is changed, like this:

RUMA_IDENTIFIERS_STORAGE="{value}"

Methods from Deref<Target = MxcUri>

pub fn as_str(&self) -> &str

Extracts a string slice from this MxcUri.

pub fn as_bytes(&self) -> &[u8]

Extracts a byte slice from this MxcUri.

pub fn media_id(&self) -> Result<&str, MxcUriError>

If this is a valid MXC URI, returns the media ID.

pub fn server_name(&self) -> Result<&ServerName, MxcUriError>

If this is a valid MXC URI, returns the server name.

pub fn parts(&self) -> Result<(&ServerName, &str), MxcUriError>

If this is a valid MXC URI, returns a (server_name, media_id) tuple, else it returns the error.

pub fn validate(&self) -> Result<(), MxcUriError>

Validates the URI and returns an error if it failed.

pub fn is_valid(&self) -> bool

Convenience method for .validate().is_ok().

Trait Implementations

impl AsRef<[u8]> for OwnedMxcUri

fn as_ref(&self) -> &[u8]

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

impl AsRef<MxcUri> for OwnedMxcUri

fn as_ref(&self) -> &MxcUri

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

impl AsRef<str> for OwnedMxcUri

fn as_ref(&self) -> &str

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

impl Borrow<MxcUri> for OwnedMxcUri

fn borrow(&self) -> &MxcUri

Immutably borrows from an owned value.

impl Clone for OwnedMxcUri

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedMxcUri

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

Formats the value using the given formatter.

impl Deref for OwnedMxcUri

type Target = MxcUri

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for OwnedMxcUri

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OwnedMxcUri

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

Formats the value using the given formatter.

impl From<&MxcUri> for OwnedMxcUri

fn from(id: &MxcUri) -> Self

Converts to this type from the input type.

impl From<&str> for OwnedMxcUri

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Box<str>> for OwnedMxcUri

fn from(s: Box<str>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for OwnedMxcUri

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<OwnedMxcUri> for Box<str>

fn from(id: OwnedMxcUri) -> Self

Converts to this type from the input type.

impl From<OwnedMxcUri> for String

fn from(id: OwnedMxcUri) -> Self

Converts to this type from the input type.

impl From<String> for OwnedMxcUri

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for OwnedMxcUri

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 OwnedMxcUri

fn cmp(&self, other: &Self) -> 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<&MxcUri> for OwnedMxcUri

fn eq(&self, other: &&MxcUri) -> 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 OwnedMxcUri

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<'a> PartialEq<Cow<'a, str>> for OwnedMxcUri

fn eq(&self, other: &Cow<'a, 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<MxcUri> for OwnedMxcUri

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

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

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

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

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

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

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

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 OwnedMxcUri

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 OwnedMxcUri

fn eq(&self, other: &Self) -> 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 OwnedMxcUri

fn partial_cmp(&self, other: &Self) -> 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 Serialize for OwnedMxcUri

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OwnedMxcUri