Struct launchdarkly_server_sdk::User

pub struct User { /* private fields */ }

A User contains specific attributes of a user browsing your site. The only mandatory property is the Key, which must uniquely identify each user. For authenticated users, this may be a username or e-mail address. For anonymous users, this could be an IP address or session ID.

Besides the mandatory key, User supports two kinds of optional attributes: interpreted attributes (e.g. IP and Country) and custom attributes. LaunchDarkly can parse interpreted attributes and attach meaning to them. For example, from an IP address, LaunchDarkly can do a geo IP lookup and determine the user’s country.

Custom attributes are not parsed by LaunchDarkly. They can be used in custom rules– for example, a custom attribute such as “customer_ranking” can be used to launch a feature to the top 10% of users on a site.

User fields are immutable and can be accessed only via getter methods. To construct a User, use the UserBuilder by calling the User::with_key.

Implementations

impl User

pub fn with_key(key: impl Into<String>) -> UserBuilder

Create a new UserBuilder, seeding it with the provided user key.

pub fn key(&self) -> &str

Returns the key of the user.

pub fn secondary(&self) -> Option<&str>

Returns the secondary key of the user, if any.

This affects feature flag targeting (https://docs.launchdarkly.com/docs/targeting-users#section-targeting-rules-based-on-user-attributes) as follows: if you have chosen to bucket users by a specific attribute, the secondary key (if set) is used to further distinguish between users who are otherwise identical according to that attribute.

pub fn ip(&self) -> Option<&str>

Returns the ip of the user, if any.

pub fn country(&self) -> Option<&str>

Returns the country of the user, if any.

pub fn email(&self) -> Option<&str>

Returns the email of the user, if any.

pub fn first_name(&self) -> Option<&str>

Returns the first name of the user, if any.

pub fn last_name(&self) -> Option<&str>

Returns the last name of the user, if any.

pub fn avatar(&self) -> Option<&str>

Returns the avatar of the user, if any.

pub fn name(&self) -> Option<&str>

Returns the name of the user, if any.

pub fn anonymous(&self) -> Option<bool>

Returns the anonymous attribute of the user.

If a user is anonymous, the user key will not appear on your LaunchDarkly dashboard.

pub fn value_of(&self, attr: &str) -> Option<AttributeValue>

Return the value of the attribute named attr.

pub fn attribute<T>(&mut self, key: &str, value: T) -> Result<(), TypeError> where
    T: Into<AttributeValue>, 

Set the attributed named key to the value value.

If there is a type conversion issue when setting the attribute, return an error of type TypeError.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<User> for User

fn eq(&self, other: &User) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &User) -> bool

This method tests for !=.

impl Serialize for User

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 StructuralPartialEq for User