launchdarkly_server_sdk_evaluation

Struct Context

Source
pub struct Context { /* private fields */ }
Expand description

Context is a collection of attributes that can be referenced in flag evaluations and analytics events. These attributes are described by one or more Kinds.

For example, a context might represent the user of a service, the description of an organization, IoT device metadata, or any combination of those at once.

To create a context of a single kind, such as a user, you may use crate::ContextBuilder.

To create a context with multiple kinds, use crate::MultiContextBuilder.

Implementations§

Source§

impl Context

Source

pub fn is_multi(&self) -> bool

Returns true if the context is a multi-context.

Source

pub fn get_value(&self, reference: &Reference) -> Option<AttributeValue>

Looks up the value of any attribute of the context, or a value contained within an attribute, based on the given reference.

This lookup includes only attributes that are addressable in evaluations– not metadata such as private attributes.

This method implements the same behavior that the SDK uses to resolve attribute references during a flag evaluation. In a single context, the reference can represent a simple attribute name– either a built-in one like “name” or “key”, or a custom attribute that was set by methods like crate::ContextBuilder::set_string– or, it can be a slash-delimited path.

For a multi-context, the only supported attribute name is “kind”. Use Context::as_kind to inspect a context for a particular Kind and then get its attributes.

Source

pub fn key(&self) -> &str

Returns the “key” attribute.

For a single context, this value is set by the crate::ContextBuilder::new or crate::ContextBuilder::key methods.

For a multi-context, there is no single key, so Context::key returns an empty string; use Context::as_kind to inspect a context for a particular kind and call Context::key on it.

Source

pub fn canonical_key(&self) -> &str

Returns the canonical key.

  1. For a single context of kind “user”, the canonical key is equivalent to the key.
  2. For other kinds of single contexts, the canonical key is “kind:key”.
  3. For a multi-context, the canonical key is the concatenation of its constituent contexts’ canonical keys with : according to (2) (including kind “user”).
Source

pub fn kind(&self) -> &Kind

Returns the “kind” attribute.

Source

pub fn as_kind(&self, kind: &Kind) -> Option<&Context>

If the specified kind exists within the context, returns a reference to it. Otherwise, returns None.

Source

pub fn context_keys(&self) -> HashMap<&Kind, &str>

Returns a map of all (kind, key) pairs contained in this context.

Source

pub fn kinds(&self) -> Vec<&Kind>

Returns a list of all kinds represented by this context.

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Context

Returns a copy of the value. Read more
1.0.0 · 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<'de> Deserialize<'de> for Context

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Context

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
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, dst: *mut T)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,