Enum stacks_rpc_client::clarity::vm::Value

pub enum Value {
    Int(i128),
    UInt(u128),
    Bool(bool),
    Sequence(SequenceData),
    Principal(PrincipalData),
    Tuple(TupleData),
    Optional(OptionalData),
    Response(ResponseData),
    CallableContract(CallableData),
}

Variants§

§

CallableContract(CallableData)

Implementations§

§

impl Value

pub fn deserialize_read<R>( r: &mut R, expected_type: Option<&TypeSignature> ) -> Result<Value, SerializationError>where R: Read,

pub fn deserialize_read_count<R>( r: &mut R, expected_type: Option<&TypeSignature> ) -> Result<(Value, u64), SerializationError>where R: Read,

Deserialize just like deserialize_read but also return the bytes read

pub fn serialize_write<W>(&self, w: &mut W) -> Result<(), Error>where W: Write,

pub fn try_deserialize_bytes( bytes: &Vec<u8>, expected: &TypeSignature ) -> Result<Value, SerializationError>

This function attempts to deserialize a byte buffer into a Clarity Value. The expected_type parameter tells the deserializer to expect (and enforce) a particular type. ClarityDB uses this to ensure that lists, tuples, etc. loaded from the database have their max-length and other type information set by the type declarations in the contract.

pub fn try_deserialize_hex( hex: &str, expected: &TypeSignature ) -> Result<Value, SerializationError>

This function attempts to deserialize a hex string into a Clarity Value. The expected_type parameter tells the deserializer to expect (and enforce) a particular type. ClarityDB uses this to ensure that lists, tuples, etc. loaded from the database have their max-length and other type information set by the type declarations in the contract.

pub fn try_deserialize_bytes_exact( bytes: &Vec<u8>, expected: &TypeSignature ) -> Result<Value, SerializationError>

This function attempts to deserialize a byte buffer into a Clarity Value, while ensuring that the whole byte buffer is consumed by the deserialization, erroring if it is not. The expected_type parameter tells the deserializer to expect (and enforce) a particular type. ClarityDB uses this to ensure that lists, tuples, etc. loaded from the database have their max-length and other type information set by the type declarations in the contract.

pub fn try_deserialize_bytes_untyped( bytes: &Vec<u8> ) -> Result<Value, SerializationError>

pub fn try_deserialize_hex_untyped( hex: &str ) -> Result<Value, SerializationError>

pub fn deserialize(hex: &str, expected: &TypeSignature) -> Value

pub fn serialized_size(&self) -> u32

§

impl Value

pub fn some(data: Value) -> Result<Value, Error>

pub fn none() -> Value

pub fn okay_true() -> Value

pub fn err_uint(ecode: u128) -> Value

pub fn err_none() -> Value

pub fn okay(data: Value) -> Result<Value, Error>

pub fn error(data: Value) -> Result<Value, Error>

pub fn size(&self) -> u32

pub fn depth(&self) -> u8

pub fn list_with_type( epoch: &StacksEpochId, list_data: Vec<Value>, expected_type: ListTypeData ) -> Result<Value, Error>

Invariant: the supplied Values have already been “checked”, i.e., it’s a valid Value object this invariant is enforced through the Value constructors, each of which checks to ensure that any typing data is correct.