Struct UserProfile 

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

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

All the profile information for a user.

Implementations

impl UserProfile

pub fn new() -> UserProfile

Creates a new empty UserProfile.

pub fn get(&self, field: &str) -> Option<&Value>

Returns the value of the given profile field.

pub fn get_static<F>( &self, ) -> Result<Option<<F as StaticProfileField>::Value>, Error>

where F: StaticProfileField,

Returns the value of the given StaticProfileField.

Returns Ok(Some(_)) if the field is present and the value was deserialized successfully, Ok(None) if the field is not set, or an error if deserialization of the value failed.

pub fn iter(&self) -> Iter<'_, String, Value>

Gets an iterator over the fields of the profile.

pub fn set(&mut self, field: String, value: Value)

Sets a field to the given value.

pub fn merge(&mut self, profile_update: UserProfileUpdate)

Available on crate feature unstable-msc4262 only.

Merges a profile that contains updates (such as from a sync response) with this profile.

This operation preserves omitted values and removes null values.

Trait Implementations

impl Clone for UserProfile

fn clone(&self) -> UserProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserProfile

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

Formats the value using the given formatter.

impl Default for UserProfile

fn default() -> UserProfile

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserProfile

fn deserialize<__D>( __deserializer: __D, ) -> Result<UserProfile, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<(ProfileFieldName, Value)> for UserProfile

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

where T: IntoIterator<Item = (ProfileFieldName, Value)>,

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<(String, Value)> for UserProfile

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

where T: IntoIterator<Item = (String, Value)>,

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 From<UserProfile> for Response

fn from(value: UserProfile) -> Response

Converts to this type from the input type.

impl From<UserProfile> for Response

fn from(value: UserProfile) -> Response

Converts to this type from the input type.

impl FromIterator<(ProfileFieldName, Value)> for UserProfile

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

where T: IntoIterator<Item = (ProfileFieldName, Value)>,

Creates a value from an iterator.

impl FromIterator<(String, Value)> for UserProfile

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

where T: IntoIterator<Item = (String, Value)>,

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 IntoIterator for UserProfile

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <UserProfile as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Serialize for UserProfile

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.