Struct Contexts

pub struct Contexts(pub Object<ContextInner>);

The Contexts interface provides additional context data. Typically, this is data related to the current user and the environment. For example, the device or application version. Its canonical name is contexts.

The contexts type can be used to define arbitrary contextual data on the event. It accepts an object of key/value pairs. The key is the “alias” of the context and can be freely chosen. However, as per policy, it should match the type of the context unless there are two values for a type. You can omit type if the key name is the type.

Unknown data for the contexts is rendered as a key/value list.

For more details about sending additional data with your event, see the full documentation on Additional Data.

Tuple Fields

0: Object<ContextInner>

Implementations

impl Contexts

pub fn new() -> Contexts

Creates an empty contexts map.

pub fn add<C>(&mut self, context: C)

where C: DefaultContext,

Inserts a context under the default key for the context.

pub fn insert(&mut self, key: String, context: Context)

Inserts a context under a custom given key.

By convention, every typed context has a default key. Use add to insert such contexts, instead.

pub fn contains<C>(&self) -> bool

where C: DefaultContext,

Returns true if a matching context resides in the map at its default key.

pub fn contains_key<S>(&self, key: S) -> bool

where S: AsRef<str>,

Returns true if a context with the provided key is present in the map.

By convention, every typed context has a default key. Use contains to check such contexts, instead.

pub fn get_or_default<C>(&mut self) -> &mut C

where C: DefaultContext,

Returns the context at its default key or constructs it if not present.

pub fn get_or_insert_with<F, S>( &mut self, key: S, context_builder: F, ) -> &mut Context

where F: FnOnce() -> Context, S: Into<String>,

Returns the context at the specified key or constructs it if not present.

By convention, every typed context has a default key. Use get_or_default to insert such contexts, instead.

pub fn get<C>(&self) -> Option<&C>

where C: DefaultContext,

Returns a reference to the default context by type.

pub fn get_mut<C>(&mut self) -> Option<&mut C>

where C: DefaultContext,

Returns a mutable reference to the default context by type.

pub fn get_key<S>(&self, key: S) -> Option<&Context>

where S: AsRef<str>,

Returns a reference to the context specified by key.

By convention, every typed context has a default key. Use get to retrieve such contexts, instead.

pub fn get_key_mut<S>(&mut self, key: S) -> Option<&mut Context>

where S: AsRef<str>,

Returns a mutable reference to the context specified by key.

By convention, every typed context has a default key. Use get_mut to retrieve such contexts, instead.

pub fn remove<C>(&mut self) -> Option<C>

where C: DefaultContext,

Removes a context from the map, returning the context it was previously in the map.

Returns Some if a matching context was removed from the default key. If the context at the default key does not have a matching type, it is removed but None is returned.

pub fn remove_key<S>(&mut self, key: S) -> Option<Context>

where S: AsRef<str>,

Removes a context from the map, returning the context it was previously in the map.

By convention, every typed context has a default key. Use remove to retrieve such contexts, instead.

Trait Implementations

impl Clone for Contexts

fn clone(&self) -> Contexts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Contexts

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

Formats the value using the given formatter.

impl Default for Contexts

fn default() -> Contexts

Returns the “default value” for a type.

impl Empty for Contexts

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 Contexts

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

Creates a meta structure from an annotated boxed value.

impl IntoValue for Contexts

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 Contexts

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

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 Contexts