Struct AdditionalParams 

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

Nonempty JSON object of provider-specific content metadata, serialized as an object under a named additional_params field rather than flattened. Constructors return None for empty maps. Bare deserialization rejects empty or non-object values; optional_additional_params maps null and empty objects to absence. Providers must replay only their own metadata.

Implementations

impl AdditionalParams

pub fn new(map: Map<String, Value>) -> Option<Self>

The canonical constructor: None when the map is empty.

pub fn from_entries<K, I>(entries: I) -> Option<Self>

where K: Into<String>, I: IntoIterator<Item = (K, Value)>,

Build from (key, value) entries; None when the iterator yields none. Option<(K, Value)> is such an iterator, so a conditional single-key params reads as AdditionalParams::from_entries(guard.then(|| (key, value))).

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

The value stored under key, when present.

pub fn as_map(&self) -> &Map<String, Value>

The underlying (non-empty) object.

pub fn into_value(self) -> Value

The params as a bare JSON object value.

pub fn merge(&mut self, incoming: Self)

Deep-merge incoming into self: arrays concatenate (streamed citation deltas), objects merge recursively, scalars take the incoming value.

pub fn wire_extras(&self, wire_key: &str) -> Option<&Map<String, Value>>

Returns the object under the provider’s own key, or None for absent or non-object values. Use Self::get to diagnose malformed values.

pub fn into_wire_extras(self, wire_key: &str) -> Option<Map<String, Value>>

Owned counterpart of Self::wire_extras for serialization paths that already own the params (the common replay case): extracts the wire’s object without cloning. Same gate semantics.

pub fn try_from_value(value: Value) -> Result<Option<Self>, Value>

Returns absence for null or empty objects, metadata for nonempty objects, or the original value as an error for other shapes.

Trait Implementations

impl Clone for AdditionalParams

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 AdditionalParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AdditionalParams

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AdditionalParams> for Value

fn from(params: AdditionalParams) -> Self

Converts to this type from the input type.

impl Index<&str> for AdditionalParams

fn index(&self, key: &str) -> &Value

Returns the value under key.

Panics

Panics if the key is absent.

type Output = Value

The returned type after indexing.

impl PartialEq for AdditionalParams

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AdditionalParams

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 AdditionalParams