Struct PluginRequestContext 

#[non_exhaustive]
pub struct PluginRequestContext {
    pub request_id: String,
    pub user_id: Option<String>,
    pub session_id: Option<String>,
    pub client_id: Option<String>,
    pub metadata: BTreeMap<String, Value>,
}

Curated request data passed to plugin tool calls.

Authentication internals and raw transport/session handles intentionally do not cross the plugin boundary.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

request_id: String

Host request identifier.

user_id: Option<String>

Authenticated user identifier, when available.

session_id: Option<String>

Stateful transport session identifier, when available.

client_id: Option<String>

Client application identifier, when available.

metadata: BTreeMap<String, Value>

Serializable request metadata copied by the host.

Implementations

impl PluginRequestContext

pub fn new(request_id: impl Into<String>) -> Self

Construct a request context for request_id.

pub fn with_user_id(self, user_id: Option<String>) -> Self

Attach the authenticated user identifier.

pub fn with_session_id(self, session_id: Option<String>) -> Self

Attach the transport session identifier.

pub fn with_client_id(self, client_id: Option<String>) -> Self

Attach the client application identifier.

pub fn with_metadata(self, metadata: BTreeMap<String, Value>) -> Self

Attach copied request metadata.

Trait Implementations

impl Clone for PluginRequestContext

fn clone(&self) -> PluginRequestContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginRequestContext

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

Formats the value using the given formatter.

impl Default for PluginRequestContext

fn default() -> PluginRequestContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginRequestContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PluginRequestContext

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PluginRequestContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PluginRequestContext