Skip to main content

Context

Struct Context 

Source
pub struct Context {
Show 14 fields pub hostname: Option<String>, pub screen: Option<String>, pub language: Option<String>, pub url: Option<String>, pub referrer: Option<String>, pub title: Option<String>, pub tag: Option<String>, pub distinct_id: Option<String>, pub ip: Option<IpAddr>, pub user_agent: Option<String>, pub browser: Option<String>, pub os: Option<String>, pub device: Option<String>, pub timestamp: Option<i64>,
}
Expand description

Visitor and page information attached to an analytics event.

Every field is optional. Umami can infer the user agent and IP address from the HTTP request, but server-side applications should normally forward the original visitor values with Context::user_agent and Context::ip.

Fields§

§hostname: Option<String>

Page hostname, for example example.com.

§screen: Option<String>

Screen size formatted as WIDTHxHEIGHT.

§language: Option<String>

Browser or application language, for example en-US.

§url: Option<String>

Page URL or path.

§referrer: Option<String>

Referring URL or path.

§title: Option<String>

Page title.

§tag: Option<String>

An additional Umami tag.

§distinct_id: Option<String>

Stable distinct ID used to associate events with a visitor.

§ip: Option<IpAddr>

Original visitor IP address for server-side tracking.

§user_agent: Option<String>

Original visitor user agent for server-side tracking.

§browser: Option<String>

Explicit browser override.

§os: Option<String>

Explicit operating-system override.

§device: Option<String>

Explicit device override.

§timestamp: Option<i64>

Event time as Unix seconds.

Implementations§

Source§

impl Context

Source

pub fn new() -> Self

Creates an empty context.

Source

pub fn hostname(self, hostname: impl Into<String>) -> Self

Sets the page hostname.

Source

pub fn screen(self, width: u32, height: u32) -> Self

Sets the screen dimensions.

Source

pub fn screen_value(self, screen: impl Into<String>) -> Self

Sets a preformatted screen value such as 1920x1080.

Source

pub fn language(self, language: impl Into<String>) -> Self

Sets the visitor language.

Source

pub fn url(self, url: impl Into<String>) -> Self

Sets the page URL or path.

Source

pub fn referrer(self, referrer: impl Into<String>) -> Self

Sets the referring URL or path.

Source

pub fn title(self, title: impl Into<String>) -> Self

Sets the page title.

Source

pub fn tag(self, tag: impl Into<String>) -> Self

Sets an Umami tag.

Source

pub fn distinct_id(self, distinct_id: impl Into<String>) -> Self

Sets a stable distinct ID.

Source

pub fn ip(self, ip: IpAddr) -> Self

Sets the original visitor IP address.

Source

pub fn user_agent(self, user_agent: impl Into<String>) -> Self

Sets the original visitor user agent.

Source

pub fn browser(self, browser: impl Into<String>) -> Self

Overrides Umami’s browser detection.

Source

pub fn os(self, os: impl Into<String>) -> Self

Overrides Umami’s operating-system detection.

Source

pub fn device(self, device: impl Into<String>) -> Self

Overrides Umami’s device detection.

Source

pub fn timestamp(self, unix_seconds: i64) -> Self

Sets the event time as Unix seconds.

Umami’s ingestion endpoint expects seconds here, unlike reporting API date ranges, which use milliseconds.

Source

pub fn at(self, time: SystemTime) -> Self

Sets the event time from a SystemTime.

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Context

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Context

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Context

Source§

impl PartialEq for Context

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Context

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Context

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more