Struct RequestMetadata 

pub struct RequestMetadata(/* private fields */);

Non-personal labels attached to a call.

Values are validated at insertion: at most MAX_METADATA_VALUE_LEN bytes, no control characters and no whitespace. That is enough for a turn id, a workflow key or an experiment label, and not enough for a sentence a user typed (spec §25.5).

Implementations

impl RequestMetadata

pub fn new() -> Self

Empty metadata.

pub fn insert( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> Result<(), MetadataError>

Inserts a label, replacing any previous value for key.

use turnframe_provider::request::RequestMetadata;

let mut metadata = RequestMetadata::new();
metadata.insert("workflow", "trip").unwrap();
// Free user text cannot be smuggled through metadata.
assert!(metadata.insert("note", "the traveler said hello").is_err());

pub fn get(&self, key: &str) -> Option<&str>

Looks a label up.

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Iterates over the labels in key order.

pub fn len(&self) -> usize

How many labels are set.

pub fn is_empty(&self) -> bool

Returns true when no label is set.

Trait Implementations

impl Clone for RequestMetadata

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestMetadata

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

Formats the value using the given formatter.

impl Default for RequestMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RequestMetadata

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialization runs the same validation as RequestMetadata::insert, so a request read back from a fixture cannot carry a label the builder would have refused.

impl Eq for RequestMetadata

impl PartialEq for RequestMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RequestMetadata

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 RequestMetadata