Struct UserProfileChanges 

#[non_exhaustive]
pub struct UserProfileChanges {
    pub updated: BTreeMap<ProfileFieldName, Value>,
    pub removed: Vec<ProfileFieldName>,
}

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

A collection of changes to be applied to a user’s profile.

This type is not supposed to be used directly, but applied to an existing UserProfile. If a profile doesn’t exist, the changes should be applied to an empty one.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

updated: BTreeMap<ProfileFieldName, Value>

Fields that have been newly set, or updated.

removed: Vec<ProfileFieldName>

Fields that have been removed from the profile.

Implementations

impl UserProfileChanges

pub fn new() -> UserProfileChanges

Creates a new empty UserProfileUpdate.

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

where F: StaticProfileField,

Returns the updated value of the given StaticProfileField.

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

pub fn insert_updated_value(&mut self, value: ProfileFieldValue)

Inserts an update for the supplied profile field value.

Trait Implementations

impl Clone for UserProfileChanges

fn clone(&self) -> UserProfileChanges

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserProfileChanges

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

Formats the value using the given formatter.

impl Default for UserProfileChanges

fn default() -> UserProfileChanges

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserProfileChanges

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UserProfileChanges

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.