Skip to main content

ValueEnvelope

Struct ValueEnvelope 

Source
pub struct ValueEnvelope {
    pub value: WireValue,
    pub type_info: TypeInfo,
    pub type_registry: TypeRegistry,
}
Expand description

Complete value envelope with metadata

This is the primary exchange format for Shape values. It contains:

  • The raw value (for lossless data transfer)
  • Type information (for proper interpretation)
  • Type registry (for metadata and display options)

Fields§

§value: WireValue

The wire-format value

§type_info: TypeInfo

Type information

§type_registry: TypeRegistry

Available metadata items for display/parsing

Implementations§

Source§

impl ValueEnvelope

Source

pub fn new( value: WireValue, type_info: TypeInfo, type_registry: TypeRegistry, ) -> Self

Create a new envelope

Source

pub fn from_value(value: WireValue) -> Self

Create an envelope with default metadata inferred from the value

Source

pub fn default_format(&self) -> &str

Get the default format name

Source

pub fn available_formats(&self) -> Vec<&str>

Get available metadata/format names

Source

pub fn has_format(&self, name: &str) -> bool

Check if a metadata item is available

Source

pub fn format_default(&self) -> Result<String>

Format the value using the default format

Source

pub fn format( &self, format_name: &str, params: &HashMap<String, Value>, ) -> Result<String>

Format the value using a specific metadata item

Source

pub fn format_with_json_params( &self, format_name: &str, params: &Value, ) -> Result<String>

Format the value with specific metadata and parameters as JSON

Source§

impl ValueEnvelope

Source

pub fn null() -> Self

Create a null envelope

Source

pub fn number(n: f64) -> Self

Create a number envelope

Source

pub fn string(s: impl Into<String>) -> Self

Create a string envelope

Source

pub fn bool(b: bool) -> Self

Create a boolean envelope

Source

pub fn timestamp(millis: i64) -> Self

Create a timestamp envelope

Trait Implementations§

Source§

impl Clone for ValueEnvelope

Source§

fn clone(&self) -> ValueEnvelope

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ValueEnvelope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ValueEnvelope

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ValueEnvelope

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ValueEnvelope

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ValueEnvelope

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,