qubit-value 0.13.1

Type-safe containers for single, multi-valued, and named runtime values
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================

//! Owned envelope used by V1 deserialization.

use serde::Deserialize;
use serde::Deserializer;

use super::WireShapeOwned;
use super::wire_envelope_owned_visitor::WireEnvelopeOwnedVisitor;

/// Owned V1 envelope accepted during deserialization.
pub(in crate::value_wire) struct WireEnvelopeOwned {
    /// Numeric protocol version supplied by the input.
    pub(in crate::value_wire) version: u8,
    /// Owned scalar-or-collection payload.
    pub(in crate::value_wire) value: WireShapeOwned,
}

impl<'de> Deserialize<'de> for WireEnvelopeOwned {
    /// Requests the named struct representation while preserving ordered
    /// sequences only for non-human-readable formats.
    ///
    /// The visitor requires one `version` and one `value` field in a map.
    /// Human-readable sequences are rejected; other formats may use exactly
    /// two sequence elements in version/value order. Errors decoding either
    /// field are propagated from the nested deserializer. Support for the
    /// decoded version is checked downstream.
    ///
    /// # Type Parameters
    ///
    /// - `D`: The Serde deserializer providing input with lifetime `'de`.
    ///
    /// # Parameters
    ///
    /// - `deserializer`: Consumed to decode the envelope; its human-readable
    ///   flag determines whether ordered sequence input is permitted.
    ///
    /// # Returns
    ///
    /// Returns the decoded version and owned payload on success, without
    /// checking whether the version is supported.
    ///
    /// # Errors
    ///
    /// Returns the deserializer's error for a malformed envelope shape, an
    /// unknown, duplicate, or missing map field, or a field value that cannot
    /// be decoded.
    #[inline]
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        let allow_sequence = !deserializer.is_human_readable();
        deserializer.deserialize_struct(
            "WireEnvelopeRef",
            &["version", "value"],
            WireEnvelopeOwnedVisitor::new(allow_sequence),
        )
    }
}