Struct MetaObject 

pub struct MetaObject(pub Map<String, Value>);

Available on crate features mcp and tools only.

General-purpose _meta map (spec MetaObject).

This is the metadata shape used by results, content blocks, and catalog descriptors (tools, prompts, resources, roots, …). It preserves arbitrary extension keys and offers helpers for the reserved W3C Trace Context keys (SEP-414).

Request and notification _meta maps have additional reserved keys; see RequestMetaObject and NotificationMetaObject.

Tuple Fields

0: Map<String, Value>

Implementations

impl MetaObject

pub fn new() -> MetaObject

Create an empty metadata map.

pub fn get_traceparent(&self) -> Option<&str>

Get the W3C traceparent value (SEP-414), if present.

pub fn set_traceparent(&mut self, value: impl Into<String>)

Set the W3C traceparent value (SEP-414).

use rmcp::model::MetaObject;

let mut meta = MetaObject::new();
meta.set_traceparent("00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01");
assert_eq!(
    meta.get_traceparent(),
    Some("00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"),
);

pub fn get_tracestate(&self) -> Option<&str>

Get the W3C tracestate value (SEP-414), if present.

pub fn set_tracestate(&mut self, value: impl Into<String>)

Set the W3C tracestate value (SEP-414).

pub fn get_baggage(&self) -> Option<&str>

Get the W3C baggage value (SEP-414), if present.

pub fn set_baggage(&mut self, value: impl Into<String>)

Set the W3C baggage value (SEP-414).

pub fn extend(&mut self, other: MetaObject)

Insert every entry of other, overwriting existing keys on conflict.

Methods from Deref<Target = Map<String, Value>>

pub fn clear(&mut self)

Clears the map, removing all values.

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

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn contains_key<Q>(&self, key: &Q) -> bool

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&String, &Value)>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Returns the key-value pair matching the given key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn insert(&mut self, k: String, v: Value) -> Option<Value>

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn shift_insert( &mut self, index: usize, k: String, v: Value, ) -> Option<Value>

Available on crate feature preserve_order only.

Insert a key-value pair in the map at the given index.

If the map did not have this key present, None is returned.

If the map did have this key present, the key is moved to the new position, the value is updated, and the old value is returned.

pub fn remove<Q>(&mut self, key: &Q) -> Option<Value>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

If serde_json’s “preserve_order” is enabled, .remove(key) is equivalent to .swap_remove(key), replacing this entry’s position with the last element. If you need to preserve the relative order of the keys in the map, use .shift_remove(key) instead.

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(String, Value)>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Removes a key from the map, returning the stored key and value if the key was previously in the map.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

If serde_json’s “preserve_order” is enabled, .remove_entry(key) is equivalent to .swap_remove_entry(key), replacing this entry’s position with the last element. If you need to preserve the relative order of the keys in the map, use .shift_remove_entry(key) instead.

pub fn swap_remove<Q>(&mut self, key: &Q) -> Option<Value>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Available on crate feature preserve_order only.

Removes and returns the value corresponding to the key from the map.

Like Vec::swap_remove, the entry is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

pub fn swap_remove_entry<Q>(&mut self, key: &Q) -> Option<(String, Value)>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Available on crate feature preserve_order only.

Remove and return the key-value pair.

Like Vec::swap_remove, the entry is removed by swapping it with the last element of the map and popping it off. This perturbs the position of what used to be the last element!

pub fn shift_remove<Q>(&mut self, key: &Q) -> Option<Value>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Available on crate feature preserve_order only.

Removes and returns the value corresponding to the key from the map.

Like Vec::remove, the entry is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

pub fn shift_remove_entry<Q>(&mut self, key: &Q) -> Option<(String, Value)>

where String: Borrow<Q>, Q: Ord + Eq + Hash + ?Sized,

Available on crate feature preserve_order only.

Remove and return the key-value pair.

Like Vec::remove, the entry is removed by shifting all of the elements that follow it, preserving their relative order. This perturbs the index of all of those elements!

pub fn append(&mut self, other: &mut Map<String, Value>)

Moves all elements from other into self, leaving other empty.

pub fn entry<S>(&mut self, key: S) -> Entry<'_>

where S: Into<String>,

Gets the given key’s corresponding entry in the map for in-place manipulation.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn iter(&self) -> Iter<'_>

Gets an iterator over the entries of the map.

pub fn iter_mut(&mut self) -> IterMut<'_>

Gets a mutable iterator over the entries of the map.

pub fn keys(&self) -> Keys<'_>

Gets an iterator over the keys of the map.

pub fn values(&self) -> Values<'_>

Gets an iterator over the values of the map.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Gets an iterator over mutable values of the map.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&String, &mut Value) -> bool,

Retains only the elements specified by the predicate.

In other words, remove all pairs (k, v) such that f(&k, &mut v) returns false.

pub fn sort_keys(&mut self)

Sorts this map’s entries in-place using str’s usual ordering.

If serde_json’s “preserve_order” feature is not enabled, this method does no work because all JSON maps are always kept in a sorted state.

If serde_json’s “preserve_order” feature is enabled, this method destroys the original source order or insertion order of this map in favor of an alphanumerical order that matches how a BTreeMap with the same contents would be ordered. This takes O(n log n + c) time where n is the length of the map and c is the capacity.

Other maps nested within the values of this map are not sorted. If you need the entire data structure to be sorted at all levels, you must also call map.values_mut().for_each(Value::sort_all_objects).

Trait Implementations

impl Clone for MetaObject

fn clone(&self) -> MetaObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetaObject

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

Formats the value using the given formatter.

impl Default for MetaObject

fn default() -> MetaObject

Returns the “default value” for a type.

impl Deref for MetaObject

type Target = Map<String, Value>

The resulting type after dereferencing.

fn deref(&self) -> &<MetaObject as Deref>::Target

Dereferences the value.

impl DerefMut for MetaObject

fn deref_mut(&mut self) -> &mut <MetaObject as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for MetaObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Map<String, Value>> for MetaObject

fn from(object: Map<String, Value>) -> MetaObject

Converts to this type from the input type.

impl From<MetaObject> for RequestMetaObject

fn from(meta: MetaObject) -> RequestMetaObject

Converts to this type from the input type.

impl From<MetaObject> for NotificationMetaObject

fn from(meta: MetaObject) -> NotificationMetaObject

Converts to this type from the input type.

impl JsonSchema for MetaObject

Available on crate feature schemars only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for MetaObject

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MetaObject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetaObject