[go: up one dir, main page]

Struct Context

Source
pub struct Context<'a> { /* private fields */ }
Expand description

Pipeline execution context.

Do not store Personally-Identifiable Information (PII) in a Context. It could easily leak in logs or traces.

Implementations§

Source§

impl<'a> Context<'a>

Source

pub fn new() -> Context<'a>

Creates a new, empty Context.

Source

pub fn with_context<'b>(context: &'a Context<'_>) -> Context<'b>
where 'a: 'b,

Returns a new Context that borrows the type map of the given context.

Once you Context::insert entities the type map is copied.

Source

pub fn with_value<E>(self, entity: E) -> Context<'a>
where E: Send + Sync + 'static,

Inserts or replaces an entity in the type map and returns Self to allow chaining.

§Examples
use typespec_client_core::http::Context;

let context = Context::new()
    .with_value(1)
    .with_value("test");
assert_eq!(context.value(), Some(&"test"));
Source

pub fn insert<E>(&mut self, entity: E) -> Option<Arc<E>>
where E: Send + Sync + 'static,

Inserts or replaces an entity in the type map. If an entity with the same type was displaced by the insert, it will be returned to the caller.

§Examples
use typespec_client_core::http::Context;
use std::sync::Arc;

let mut context = Context::new().with_value("a".to_string());
assert_eq!(context.insert("b".to_string()), Some(Arc::new("a".to_string())));
assert_eq!(context.value(), Some(&"b".to_string()));
Source

pub fn value<E>(&self) -> Option<&E>
where E: Send + Sync + 'static,

Returns a reference of the entity of the specified type signature, if it exists.

If there is no entity with the specific type signature, None is returned instead.

Source

pub fn is_empty(&self) -> bool

Returns true if the type map is empty; otherwise, false.

Source

pub fn into_owned(self) -> Context<'static>

Transforms this Context into a new Context that owns the underlying data, cloning it if necessary.

If this Context already owns the underlying data, that data is moved into the new Context as-is. If this Context is borrowing it’s underlying data, that data is cloned and returned as a new Context.

Trait Implementations§

Source§

impl<'a> Clone for Context<'a>

Source§

fn clone(&self) -> Context<'a>

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<'a> Debug for Context<'a>

Source§

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

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

impl Default for Context<'_>

Source§

fn default() -> Context<'_>

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

Auto Trait Implementations§

§

impl<'a> Freeze for Context<'a>

§

impl<'a> !RefUnwindSafe for Context<'a>

§

impl<'a> Send for Context<'a>

§

impl<'a> Sync for Context<'a>

§

impl<'a> Unpin for Context<'a>

§

impl<'a> !UnwindSafe for Context<'a>

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 u8)

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T