Enum clarity_repl::clarity::types::Value

source · [−]

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>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn expect_list(self) -> Vec<Value>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn expect_buff_padded(self, sz: usize, pad: u8) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Value

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

Formats the value using the given formatter. Read more

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. Read more

impl Display for Value

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

Formats the value using the given formatter. Read more

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 ==. Read more

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

This method tests for !=.

impl SequencedValue<Value> for ListData

fn items(&self) -> &Vec<Value>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn drained_items(&mut self) -> Vec<Value>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn type_signature(&self) -> TypeSignature

fn to_value(v: &Value) -> Value

fn atom_values(&mut self) -> Vec<SymbolicExpression>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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. Read more

impl StacksMessageCodec for Value

fn consensus_serialize<W: Write>(&self, fd: &mut W) -> Result<(), CodecError>

serialize implementors should never error unless there is an underlying failure in writing to the fd Read more

fn consensus_deserialize<R: Read>(fd: &mut R) -> Result<Value, CodecError>

fn serialize_to_vec(&self) -> Vec<u8>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,` where
Self: Sized,

Convenience for serialization to a vec. this function unwraps any underlying serialization error Read more

impl Eq for Value

impl StructuralEq for Value

impl StructuralPartialEq for Value

Auto Trait Implementations

impl RefUnwindSafe for Value

impl Send for Value

impl Sync for Value

impl Unpin for Value

impl UnwindSafe for Value

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> Same<T> for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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