Struct ValueWirePayloadV1 

pub struct ValueWirePayloadV1 { /* private fields */ }

Typed V1 scalar-or-collection payload without an enclosing version field.

Deserialization is intentionally available through crate::ValueWirePayloadV1Seed, which lets a bounded decoder control the complete input and structure.

Examples

use std::convert::TryFrom;
use qubit_value::{Value, ValueWirePayloadV1};

let _payload = ValueWirePayloadV1::try_from(Value::from(42_i32)).unwrap();

Implementations

impl ValueWirePayloadV1

pub fn default_json_decode_limits() -> JsonDecodeLimits

Returns the default JSON resource profile for complete V1 payloads.

Returns

Decode limits suitable for one standalone unversioned V1 payload.

pub fn default_json_encode_limits() -> JsonEncodeLimits

Returns the default JSON resource profile for complete V1 payloads.

Returns

Encode limits suitable for one standalone unversioned V1 payload.

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

Decodes a complete V1 JSON payload using default resource limits.

Prefer this entry point when the payload itself is the complete untrusted document. Embedded protocols should share one budget across all payloads in their complete document.

Parameters

• input - Complete UTF-8 JSON payload to decode.

Returns

The decoded unversioned V1 payload.

Errors

Returns a limit error when the input or decoded structure is too large, or ValueWireDecodeError::InvalidJson for malformed input.

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

Decodes a complete V1 JSON payload using explicit resource limits.

Parameters

• input - Complete UTF-8 JSON payload to decode.
• limits - Resource limits enforced during decoding.

Returns

The decoded unversioned V1 payload.

Errors

Returns a limit error when input or its decoded structure exceeds limits, or ValueWireDecodeError::InvalidJson for malformed input.

pub fn to_json_vec(&self) -> Result<Vec<u8>, ValueWireEncodeError>

Encodes this V1 payload into a compact JSON vector with default limits.

Returns

Compact UTF-8 JSON bytes for this unversioned payload.

Errors

Returns ValueWireEncodeError::Budget when the payload exceeds the default JSON resource profile.

pub fn to_json_vec_with_limits( &self, limits: JsonEncodeLimits, ) -> Result<Vec<u8>, ValueWireEncodeError>

Encodes this V1 payload into a bounded compact JSON vector.

Parameters

• limits - Resource limits enforced during encoding.

Returns

Compact UTF-8 JSON bytes for this unversioned payload.

Errors

Returns ValueWireEncodeError when encoding exceeds limits or the payload cannot be serialized.

pub fn to_json_writer<W>(&self, writer: W) -> Result<(), ValueWireEncodeError>

where W: Write,

Encodes this V1 payload to a writer with default limits.

Type Parameters

• W - Destination writer type.

Parameters

• writer - Destination receiving the complete JSON payload.

Returns

Ok(()) after the complete payload is written.

Errors

Returns ValueWireEncodeError::Budget for resource-limit failures or ValueWireEncodeError::Io when writer rejects output.

pub fn to_json_writer_with_limits<W>( &self, writer: W, limits: JsonEncodeLimits, ) -> Result<(), ValueWireEncodeError>

where W: Write,

Encodes this V1 payload to a writer after enforcing JSON budgets.

Type Parameters

• W - Destination writer type.

Parameters

• writer - Destination receiving the complete JSON payload.
• limits - Resource limits enforced during encoding.

Returns

Ok(()) after the complete payload is written.

Errors

Returns ValueWireEncodeError when encoding exceeds limits, the payload cannot be serialized, or writer rejects output.

pub const fn container(&self) -> &ValueContainer

Borrows the preserved runtime value.

Returns

A shared reference to the preserved scalar-or-collection container.

pub fn into_container(self) -> ValueContainer

Consumes this payload and returns its runtime value.

Returns

The preserved scalar-or-collection container.

Trait Implementations

impl Clone for ValueWirePayloadV1

fn clone(&self) -> ValueWirePayloadV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueWirePayloadV1

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

Formats the value using the given formatter.

impl Eq for ValueWirePayloadV1

impl From<ValueWirePayloadV1> for ValueContainer

fn from(value: ValueWirePayloadV1) -> Self

Extracts the shaped runtime value from a V1 payload.

impl Hash for ValueWirePayloadV1

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ValueWirePayloadV1

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ValueWirePayloadV1

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serializes the unversioned V1 shape.

impl StructuralPartialEq for ValueWirePayloadV1

impl TryFrom<MultiValues> for ValueWirePayloadV1

fn try_from(value: MultiValues) -> Result<Self, Self::Error>

Validates a collection for use in a V1 payload.

type Error = ValueWireEncodeError

The type returned in the event of a conversion error.

impl TryFrom<Value> for ValueWirePayloadV1

fn try_from(value: Value) -> Result<Self, Self::Error>

Validates a scalar for use in a V1 payload.

type Error = ValueWireEncodeError

The type returned in the event of a conversion error.

impl TryFrom<ValueContainer> for ValueWirePayloadV1

fn try_from(value: ValueContainer) -> Result<Self, Self::Error>

Validates an explicitly shaped value for use in a V1 payload.

type Error = ValueWireEncodeError

The type returned in the event of a conversion error.