Enum clarity_repl::clarity::types::Value

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

Variants

Int(i128)

UInt(u128)

Bool(bool)

Sequence(SequenceData)

Principal(PrincipalData)

Tuple(TupleData)

Optional(OptionalData)

Response(ResponseData)

Implementations

impl Value

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

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

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

This function attempts to deserialize a hex string into a Clarity Value. The expected_type parameter determines whether or not the deserializer should 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. If passed None, the deserializer will construct the values as if they were literals in the contract, e.g., list max length = the length of the list.

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

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) -> Self

impl Value

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

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>

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

pub fn size(&self) -> u32

pub fn depth(&self) -> u8

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

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.

pub fn list_from(list_data: Vec<Value>) -> Result<Value>

pub fn buff_from(buff_data: Vec<u8>) -> Result<Value>

pub fn buff_from_byte(byte: u8) -> Value

pub fn string_ascii_from_bytes(bytes: Vec<u8>) -> Result<Value>

pub fn string_utf8_from_string_utf8_literal(
    tokenized_str: String
) -> Result<Value>

pub fn string_utf8_from_bytes(bytes: Vec<u8>) -> Result<Value>

pub fn expect_ascii(self) -> String

pub fn expect_u128(self) -> u128

pub fn expect_i128(self) -> i128

pub fn expect_buff(self, sz: usize) -> Vec<u8>

pub fn expect_list(self) -> Vec<Value>

pub fn expect_buff_padded(self, sz: usize, pad: u8) -> Vec<u8>

pub fn expect_bool(self) -> bool

pub fn expect_tuple(self) -> TupleData

pub fn expect_optional(self) -> Option<Value>

pub fn expect_principal(self) -> PrincipalData

pub fn expect_result(self) -> Result<Value, Value>

pub fn expect_result_ok(self) -> Value

pub fn expect_result_err(self) -> Value

Trait Implementations

impl ClarityDeserializable<Value> for Value

fn deserialize(hex: &str) -> Self

impl ClaritySerializable for Value

fn serialize(&self) -> String

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Value

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

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl Eq for Value

impl From<&'_ Value> for TypePrefix

fn from(v: &Value) -> TypePrefix

Performs the conversion.

impl From<PrincipalData> for Value

fn from(p: PrincipalData) -> Self

Performs the conversion.

impl From<QualifiedContractIdentifier> for Value

fn from(principal: QualifiedContractIdentifier) -> Self

Performs the conversion.

impl From<StandardPrincipalData> for Value

fn from(principal: StandardPrincipalData) -> Self

Performs the conversion.

impl From<TupleData> for Value

fn from(t: TupleData) -> Self

Performs the conversion.

impl Into<Value> for ShortReturnType

fn into(self) -> Value

Performs the conversion.

impl MemoryConsumer for Value

fn get_memory_use(&self) -> u64

impl PartialEq<Value> for Value

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

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

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

This method tests for !=.

impl SequencedValue<Value> for ListData

fn items(&self) -> &Vec<Value>

fn drained_items(&mut self) -> Vec<Value>

fn type_signature(&self) -> TypeSignature

fn to_value(v: &Value) -> Value

fn atom_values(&mut self) -> Vec<SymbolicExpression>

impl Serialize for Value

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Value

impl StructuralPartialEq for Value