Struct User

pub struct User {
    pub id: Annotated<LenientString>,
    pub email: Annotated<String>,
    pub ip_address: Annotated<IpAddr>,
    pub username: Annotated<LenientString>,
    pub name: Annotated<String>,
    pub sentry_user: Annotated<String>,
    pub geo: Annotated<Geo>,
    pub segment: Annotated<String>,
    pub data: Annotated<Object<Value>>,
    pub other: Object<Value>,
}

Information about the user who triggered an event.

{
  "user": {
    "id": "unique_id",
    "username": "my_user",
    "email": "foo@example.com",
    "ip_address": "127.0.0.1",
    "subscription": "basic"
  }
}

Fields

id: Annotated<LenientString>

Unique identifier of the user.

email: Annotated<String>

Email address of the user.

ip_address: Annotated<IpAddr>

Remote IP address of the user. Defaults to “{{auto}}”.

username: Annotated<LenientString>

Username of the user.

name: Annotated<String>

Human readable name of the user.

sentry_user: Annotated<String>

The user string representation as handled in Sentry.

This field is computed by concatenating the name of specific fields of the User struct with their value. For example, if id is set, sentry_user will be equal to `“id:id-of-the-user”.

geo: Annotated<Geo>

Approximate geographical location of the end user or device.

segment: Annotated<String>

The user segment, for apps that divide users in user segments.

data: Annotated<Object<Value>>

Additional arbitrary fields, as stored in the database (and sometimes as sent by clients). All data from self.other should end up here after store normalization.

other: Object<Value>

Additional arbitrary fields, as sent by clients.

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

Formats the value using the given formatter.

impl Default for User

fn default() -> User

Returns the “default value” for a type.

impl Empty for User

fn is_empty(&self) -> bool

Returns whether this value is empty.

fn is_deep_empty(&self) -> bool

Returns whether this value is empty or all of its descendants are empty.

impl FromValue for User

fn from_value(__value: Annotated<Value>) -> Annotated<Self>

Creates a meta structure from an annotated boxed value.

impl IntoValue for User

fn into_value(self) -> Value

Boxes the meta structure back into a value.

fn serialize_payload<S>( &self, __serializer: S, __behavior: SkipSerialization, ) -> Result<S::Ok, S::Error>

where Self: Sized, S: Serializer,

Efficiently serializes the payload directly.

fn extract_child_meta(&self) -> MetaMap

where Self: Sized,

Extracts children meta map out of a value.

fn extract_meta_tree(value: &Annotated<Self>) -> MetaTree

where Self: Sized,

Extracts the meta tree out of annotated value.

impl PartialEq for User

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

fn value_type(&self) -> EnumSet<ValueType>

Returns the type of the value.

fn process_value<P>( &mut self, __meta: &mut Meta, __processor: &mut P, __state: &ProcessingState<'_>, ) -> ProcessingResult

where P: Processor,

Executes a processor on this value.

fn process_child_values<P>( &mut self, __processor: &mut P, __state: &ProcessingState<'_>, ) -> ProcessingResult

where P: Processor,

Recurses into children of this value.

impl StructuralPartialEq for User