BamlValue

Enum BamlValue 

Source
pub enum BamlValue<T: KnownTypes, S: KnownTypes> {
Show 14 variants String(String), Int(i64), Float(f64), Bool(bool), Null, List(Vec<BamlValue<T, S>>), Map(HashMap<String, BamlValue<T, S>>), Known(T), StreamKnown(S), Checked(Checked<Box<BamlValue<T, S>>>), StreamState(StreamState<Box<BamlValue<T, S>>>), DynamicClass(DynamicClass<T, S>), DynamicEnum(DynamicEnum), DynamicUnion(DynamicUnion<T, S>),
}
Expand description

A dynamically-typed BAML value, parameterized by two type enums:

  • T: Regular known types (e.g., types::Person)
  • S: Stream known types (e.g., stream_types::Person with Option fields)

In non-streaming contexts, StreamKnown(S) is an invariant (never appears).

Variants§

§

String(String)

§

Int(i64)

§

Float(f64)

§

Bool(bool)

§

Null

§

List(Vec<BamlValue<T, S>>)

§

Map(HashMap<String, BamlValue<T, S>>)

§

Known(T)

§

StreamKnown(S)

§

Checked(Checked<Box<BamlValue<T, S>>>)

§

StreamState(StreamState<Box<BamlValue<T, S>>>)

§

DynamicClass(DynamicClass<T, S>)

§

DynamicEnum(DynamicEnum)

§

DynamicUnion(DynamicUnion<T, S>)

Implementations§

Source§

impl<T: KnownTypes, S: KnownTypes> BamlValue<T, S>

Source

pub fn get<V: FromBamlValue<T, S>>(self) -> Result<V, BamlError>

Convert this BamlValue to the specified type.

Source

pub fn get_ref<'a, V: FromBamlValueRef<'a, T, S>>( &'a self, ) -> Result<V, BamlError>

Borrow this BamlValue as the specified type (zero-copy).

Trait Implementations§

Source§

impl<T: KnownTypes, S: KnownTypes> BamlDecode for BamlValue<T, S>

Source§

fn baml_decode(holder: &CffiValueHolder) -> Result<Self, BamlError>

Decode from a CffiValueHolder (outbound schema)
Source§

impl<T: KnownTypes, S: KnownTypes> BamlEncode for BamlValue<T, S>

Source§

fn baml_encode(&self) -> HostValue

Encode to a HostValue (inbound schema)
Source§

impl<T: Clone + KnownTypes, S: Clone + KnownTypes> Clone for BamlValue<T, S>

Source§

fn clone(&self) -> BamlValue<T, S>

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<T: Debug + KnownTypes, S: Debug + KnownTypes> Debug for BamlValue<T, S>

Source§

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

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

impl<T: KnownTypes, S: KnownTypes> FromBamlValue<T, S> for BamlValue<T, S>

Identity impl - extract BamlValue from BamlValue

Auto Trait Implementations§

§

impl<T, S> Freeze for BamlValue<T, S>
where T: Freeze, S: Freeze,

§

impl<T, S> RefUnwindSafe for BamlValue<T, S>

§

impl<T, S> Send for BamlValue<T, S>
where T: Send, S: Send,

§

impl<T, S> Sync for BamlValue<T, S>
where T: Sync, S: Sync,

§

impl<T, S> Unpin for BamlValue<T, S>
where T: Unpin, S: Unpin,

§

impl<T, S> UnwindSafe for BamlValue<T, S>
where T: UnwindSafe, S: UnwindSafe,

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.