Enum candid::types::value::IDLValue

pub enum IDLValue {
    Bool(bool),
    Null,
    Text(String),
    Number(String),
    Float64(f64),
    Opt(Box<IDLValue>),
    Vec(Vec<IDLValue>),
    Record(Vec<IDLField>),
    Variant(VariantValue),
    Blob(Vec<u8>),
    Principal(Principal),
    Service(Principal),
    Func(Principal, String),
    None,
    Int(Int),
    Nat(Nat),
    Nat8(u8),
    Nat16(u16),
    Nat32(u32),
    Nat64(u64),
    Int8(i8),
    Int16(i16),
    Int32(i32),
    Int64(i64),
    Float32(f32),
    Reserved,
}

Available on crate feature value only.

Variants

Bool(bool)

Null

Text(String)

Number(String)

Float64(f64)

Opt(Box<IDLValue>)

Vec(Vec<IDLValue>)

Record(Vec<IDLField>)

Variant(VariantValue)

Blob(Vec<u8>)

Principal(Principal)

Service(Principal)

Func(Principal, String)

None

Int(Int)

Nat(Nat)

Nat8(u8)

Nat16(u16)

Nat32(u32)

Nat64(u64)

Int8(i8)

Int16(i16)

Int32(i32)

Int64(i64)

Float32(f32)

Reserved

Implementations

impl IDLValue

pub fn annotate_type( &self, from_parser: bool, env: &TypeEnv, t: &Type ) -> Result<Self>

Anotate IDLValue with the given type, allowing subtyping. If IDLValue is parsed from string, we need to set from_parser to true to enable converting numbers to the expected types, and disable the opt rules.

pub fn value_ty(&self) -> Type

pub fn try_from_candid_type<T>(data: &T) -> Result<Self>

where T: CandidType,

Converts data that implements CandidType into an IDLValue.

Example: Convert data to candid text format

#[derive(CandidType)]
struct MyStruct {
   a: u8,
  b: String,
}
let my_struct = MyStruct { a: 42, b: "hello".to_string() };
let idl_value = IDLValue::try_from_candid_type(&my_struct).unwrap();
let expected_text = "record { a = 42 : nat8; b = \"hello\" }";
let actual_text = idl_value.to_string();
assert_eq!(expected_text, actual_text);

Trait Implementations

impl CandidType for IDLValue

fn ty() -> Type

fn id() -> TypeId

fn _ty() -> Type

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

where S: Serializer,

impl Clone for IDLValue

fn clone(&self) -> IDLValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IDLValue

Available on crate feature printer only.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IDLValue

fn deserialize<D>(deserializer: D) -> Result<IDLValue, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IDLValue

Available on crate feature printer only.

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

Formats the value using the given formatter.

impl PartialEq for IDLValue

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IDLValue