Enum ProfileFieldValue 

#[non_exhaustive]
pub enum ProfileFieldValue {
    AvatarUrl(OwnedMxcUri),
    DisplayName(String),
    TimeZone(String),
    Status(StatusProfileField),
    Call(CallProfileField),
}

The possible values of a field of a user’s profile.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AvatarUrl(OwnedMxcUri)

The user’s avatar URL.

DisplayName(String)

The user’s display name.

TimeZone(String)

The user’s time zone.

Status(StatusProfileField)

Available on crate feature unstable-msc4426 only.

The user’s current status.

This uses the unstable prefix defined in MSC4426.

Call(CallProfileField)

Available on crate feature unstable-msc4426 only.

The user’s call indicator.

This uses the unstable prefix defined in MSC4426.

Implementations

impl ProfileFieldValue

pub fn new(field: &str, value: Value) -> Result<ProfileFieldValue, Error>

Available on crate feature api and (crate features client-api-c or client-api-s) and (crate features client or server) only.

Construct a new ProfileFieldValue with the given field and value.

Prefer to use the public variants of ProfileFieldValue where possible; this constructor is meant to be used for unsupported fields only and does not allow setting arbitrary data for supported ones.

Errors

Returns an error if the field is known and serialization of value to the corresponding ProfileFieldValue variant fails.

pub fn field_name(&self) -> ProfileFieldName

Available on crate feature api and (crate features client-api-c or client-api-s) and (crate features client or server) only.

The name of the field for this value.

pub fn value(&self) -> Cow<'_, Value>

Available on crate feature api and (crate features client-api-c or client-api-s) and (crate features client or server) only.

Returns the value of the field.

Prefer to use the public variants of ProfileFieldValue where possible; this method is meant to be used for custom fields only.

Trait Implementations

impl Clone for ProfileFieldValue

fn clone(&self) -> ProfileFieldValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProfileFieldValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProfileFieldValue

fn deserialize<D>( deserializer: D, ) -> Result<ProfileFieldValue, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<ProfileFieldValue> for Response

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = ProfileFieldValue>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<ProfileFieldValue> for Response

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = ProfileFieldValue>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<ProfileFieldValue> for UserProfile

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = ProfileFieldValue>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ProfileFieldValue> for Response

fn from_iter<T>(iter: T) -> Response

where T: IntoIterator<Item = ProfileFieldValue>,

Creates a value from an iterator.

impl FromIterator<ProfileFieldValue> for Response

fn from_iter<T>(iter: T) -> Response

where T: IntoIterator<Item = ProfileFieldValue>,

Creates a value from an iterator.

impl FromIterator<ProfileFieldValue> for UserProfile

fn from_iter<T>(iter: T) -> UserProfile

where T: IntoIterator<Item = ProfileFieldValue>,

Creates a value from an iterator.

impl PartialEq for ProfileFieldValue

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProfileFieldValue

impl StructuralPartialEq for ProfileFieldValue