Struct OwnedDeviceId 

pub struct OwnedDeviceId { /* private fields */ }

Owned variant of DeviceId

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}"

Implementations

impl OwnedDeviceId

pub fn zeroize(self)

Securely zero memory (aka zeroize) of OwnedDeviceId.

This method zeroizes this type by writing zeros in its memory location before freeing it. It internally uses the zeroize crate. Note that this type doesn’t implement the zeroize::Zeroize trait because the Zeroize::zeroize method takes a &mut self, which means we could put this type into an inconsistent state if it is used after calling that method. Instead, this method takes ownership of the type, ensuring it’s impossible to misuse it.

Implementation details

If the ruma_identifiers_storage configuration is set to Arc, this type will be zeroized if and only if Arc::get_mut returns Some reference, i.e. if there is no other Arc or Weak pointers to this same location.

Methods from Deref<Target = DeviceId>

pub fn as_str(&self) -> &str

Extracts a string slice from this DeviceId.

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

Extracts a byte slice from this DeviceId.

Trait Implementations

impl AsRef<DeviceId> for OwnedDeviceId

fn as_ref(&self) -> &DeviceId

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

impl AsRef<[u8]> for OwnedDeviceId

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

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

impl AsRef<str> for OwnedDeviceId

fn as_ref(&self) -> &str

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

impl Borrow<DeviceId> for OwnedDeviceId

fn borrow(&self) -> &DeviceId

Immutably borrows from an owned value.

impl Borrow<str> for OwnedDeviceId

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for OwnedDeviceId

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 OwnedDeviceId

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

Formats the value using the given formatter.

impl Deref for OwnedDeviceId

type Target = DeviceId

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for OwnedDeviceId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OwnedDeviceId

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

Formats the value using the given formatter.

impl Eq for OwnedDeviceId

impl From<&DeviceId> for OwnedDeviceId

fn from(id: &DeviceId) -> Self

Converts to this type from the input type.

impl From<&str> for OwnedDeviceId

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Box<str>> for OwnedDeviceId

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<OwnedDeviceId> for OwnedBase64PublicKeyOrDeviceId

fn from(value: OwnedDeviceId) -> Self

Converts to this type from the input type.

impl From<OwnedDeviceId> for Box<str>

fn from(id: OwnedDeviceId) -> Self

Converts to this type from the input type.

impl From<OwnedDeviceId> for String

fn from(id: OwnedDeviceId) -> Self

Converts to this type from the input type.

impl From<OwnedDeviceId> for DeviceIdOrAllDevices

fn from(d: OwnedDeviceId) -> Self

Converts to this type from the input type.

impl From<String> for OwnedDeviceId

fn from(s: String) -> Self

Converts to this type from the input type.

impl Hash for OwnedDeviceId

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 KeyName for OwnedDeviceId

fn validate(_s: &str) -> Result<(), IdParseError>

Validate the given string for this name.

impl Ord for OwnedDeviceId

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 for OwnedDeviceId

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 PartialEq<&DeviceId> for OwnedDeviceId

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

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 OwnedDeviceId

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<DeviceId> for OwnedDeviceId

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

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

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

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

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

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

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

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 OwnedDeviceId

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 PartialOrd for OwnedDeviceId

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 OwnedDeviceId

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

where S: Serializer,

Serialize this value into the given Serde serializer.