Struct NamedMultiValues

Source

pub struct NamedMultiValues { /* private fields */ }

Expand description

Named multiple values

A container that associates a readable name with a set of MultiValues, suitable for organizing data in key-value (name-multiple values) scenarios, such as configuration items, command-line parameter aggregation, structured log fields, etc.

§Features

Provides clear name identification for multiple value collections
Exposes the inner MultiValues through explicit accessors
Supports serde serialization and deserialization

§Use Cases

Aggregating a set of ports, hostnames, etc., as semantically meaningful fields
Outputting named multiple value lists in configurations/logs

§Examples

use qubit_value::{NamedMultiValues, MultiValues};

// Identify a group of ports with the name "ports"
let named = NamedMultiValues::new(
    "ports",
    MultiValues::Int32(vec![8080, 8081, 8082])
);

assert_eq!(named.name(), "ports");
assert_eq!(named.values().len(), 3);

The wrapper intentionally does not forward MultiValues methods implicitly:

use qubit_value::{MultiValues, NamedMultiValues};

let named = NamedMultiValues::new("ports", MultiValues::Int32(vec![8080]));
let _ = named.len();

Implementations§

Source §

impl NamedMultiValues

Source

pub fn new(name: impl Into<String>, value: MultiValues) -> Self

Create a new named multiple values

Associates a given name with MultiValues, generating a container that can be referenced by name.

§Use Cases

Building configuration fields (e.g., servers, ports, etc.)
Binding parsed multiple value results to semantic names

§Parameters

name - Name of the multiple values
value - Content of the multiple values

§Returns

Returns a newly created named multiple values

§Examples

use qubit_value::{NamedMultiValues, MultiValues};

let named = NamedMultiValues::new(
    "servers",
    MultiValues::String(vec!["s1".to_string(), "s2".to_string()])
);
assert_eq!(named.name(), "servers");

Source

pub fn decode_json_slice(input: &[u8]) -> Result<Self, ValueWireDecodeError>

Decodes a complete named collection JSON document with default limits.

§Parameters

input - Complete UTF-8 JSON document to decode.

§Returns

The decoded named collection.

§Errors

Returns a JSON, wire-contract, or resource-limit error.

Source

pub fn decode_json_slice_with_limits( input: &[u8], limits: WireLimits, ) -> Result<Self, ValueWireDecodeError>

Decodes a complete named collection JSON document with explicit limits.

The wrapper name and nested collection share one accounting session.

§Parameters

input - Complete UTF-8 JSON document to decode.
limits - Input and decoded-resource limits.

§Returns

The decoded named collection.

§Errors

Returns a JSON, wire-contract, or resource-limit error.

Source

pub fn name(&self) -> &str

Get a reference to the name

§Returns

Returns a string slice of the name

§Examples

use qubit_value::{NamedMultiValues, MultiValues};

let named = NamedMultiValues::new("items", MultiValues::Int32(vec![1, 2, 3]));
assert_eq!(named.name(), "items");

Source

pub fn set_name(&mut self, name: impl Into<String>)

Set a new name

§Parameters

name - The new name

§Returns

No return value

§Examples

use qubit_value::{NamedMultiValues, MultiValues};

let mut named = NamedMultiValues::new("old", MultiValues::Bool(vec![true]));
named.set_name("new");
assert_eq!(named.name(), "new");

Source

pub fn values(&self) -> &MultiValues

Borrows the contained values.

§Returns

A shared reference to the contained MultiValues.

Source

pub fn values_mut(&mut self) -> &mut MultiValues

Mutably borrows the contained values.

§Returns

An exclusive reference to the contained MultiValues.

Source

pub fn set_values(&mut self, values: MultiValues)

Replaces the contained values.

§Parameters

values - New collection to store under the existing name.

Source

pub fn into_parts(self) -> (String, MultiValues)

Consumes this wrapper and returns its owned name and values.

§Returns

The (name, values) pair without cloning either component.

Source

pub fn first_named_value(&self) -> NamedValue

Convert this named multi-values into a named single value.

The returned value keeps the same name and uses the first element from the inner MultiValues. If there is no element, the returned value is Value::Unset with the same data type.