Struct launchdarkly_server_sdk::User
source · pub struct User { /* private fields */ }
Expand description
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
sourceimpl User
impl User
sourcepub fn with_key(key: impl Into<String>) -> UserBuilder
pub fn with_key(key: impl Into<String>) -> UserBuilder
Create a new UserBuilder, seeding it with the provided user key.
sourcepub fn secondary(&self) -> Option<&str>
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.
sourcepub fn first_name(&self) -> Option<&str>
pub fn first_name(&self) -> Option<&str>
Returns the first name of the user, if any.
sourcepub fn anonymous(&self) -> Option<bool>
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.
sourcepub fn value_of(&self, attr: &str) -> Option<AttributeValue>
pub fn value_of(&self, attr: &str) -> Option<AttributeValue>
Return the value of the attribute named attr
.