Skip to main content

Context

Struct Context 

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

A type-safe container for request-scoped data.

Context allows you to pass metadata through policy execution without modifying function signatures.

§Examples

use do_over::context::{Context, ContextKey};

static CORRELATION_ID: ContextKey<String> = ContextKey::new("correlation_id");
static RETRY_COUNT: ContextKey<u32> = ContextKey::new("retry_count");

let mut ctx = Context::new();
ctx.insert(&CORRELATION_ID, "abc-123".to_string());
ctx.insert(&RETRY_COUNT, 0u32);

assert_eq!(ctx.get(&CORRELATION_ID), Some(&"abc-123".to_string()));
assert_eq!(ctx.get(&RETRY_COUNT), Some(&0u32));

Implementations§

Source§

impl Context

Source

pub fn new() -> Self

Create a new empty context.

Source

pub fn insert<T: Send + Sync + 'static>( &mut self, key: &ContextKey<T>, value: T, )

Insert a value into the context.

§Arguments
  • key - The context key
  • value - The value to store
§Examples
use do_over::context::{Context, ContextKey};

static KEY: ContextKey<String> = ContextKey::new("key");

let mut ctx = Context::new();
ctx.insert(&KEY, "value".to_string());
Source

pub fn get<T: Send + Sync + 'static>(&self, key: &ContextKey<T>) -> Option<&T>

Get a value from the context.

§Arguments
  • key - The context key
§Returns

A reference to the value if it exists, or None.

§Examples
use do_over::context::{Context, ContextKey};

static KEY: ContextKey<String> = ContextKey::new("key");

let mut ctx = Context::new();
ctx.insert(&KEY, "value".to_string());

assert_eq!(ctx.get(&KEY), Some(&"value".to_string()));
Source

pub fn remove<T: Send + Sync + Clone + 'static>( &mut self, key: &ContextKey<T>, ) -> Option<T>

Remove a value from the context.

§Arguments
  • key - The context key
§Returns

The removed value if it existed (cloned before removal).

Source

pub fn contains<T: Send + Sync + 'static>(&self, key: &ContextKey<T>) -> bool

Check if the context contains a key.

Source

pub fn clear(&mut self)

Clear all values from the context.

Trait Implementations§

Source§

impl Clone for Context

Source§

fn clone(&self) -> Self

Returns a duplicate 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 Default for Context

Source§

fn default() -> Context

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

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, 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> 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.