Struct CLValue

pub struct CLValue { /* private fields */ }

A Casper value, i.e. a value which can be stored and manipulated by smart contracts.

It holds the underlying data as a type-erased, serialized Vec<u8> and also holds the CLType of the underlying data as a separate member.

Implementations

impl CLValue

pub fn from_t<T: CLTyped + ToBytes>(t: T) -> Result<CLValue, CLValueError>

Constructs a CLValue from t.

pub fn to_t<T: CLTyped + FromBytes>(&self) -> Result<T, CLValueError>

Converts self into its underlying type.

pub fn into_t<T: CLTyped + FromBytes>(self) -> Result<T, CLValueError>

Consumes and converts self back into its underlying type.

pub fn unit() -> Self

A convenience method to create CLValue for a unit.

pub fn cl_type(&self) -> &CLType

The CLType of the underlying data.

pub fn inner_bytes(&self) -> &Vec<u8>

Returns a reference to the serialized form of the underlying value held in this CLValue.

pub fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> yielded after calling self.to_bytes().

Note, this method doesn’t actually serialize self, and hence is relatively cheap.

Trait Implementations

impl Clone for CLValue

fn clone(&self) -> CLValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for CLValue

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for CLValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CLValue

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<CLValue> for StoredValue

fn from(value: CLValue) -> StoredValue

Converts to this type from the input type.

impl FromBytes for CLValue

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl Hash for CLValue

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for CLValue

Available on crate feature json-schema only.

We need to implement JsonSchema for CLValue as though it is a CLValueJson.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for CLValue

fn cmp(&self, other: &CLValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CLValue

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for CLValue

fn partial_cmp(&self, other: &CLValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CLValue

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToBytes for CLValue

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn into_bytes(self) -> Result<Vec<u8>, Error>

Consumes self and serializes to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

impl TryFrom<StoredValue> for CLValue

type Error = TypeMismatch

The type returned in the event of a conversion error.

fn try_from(stored_value: StoredValue) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CLValue

impl StructuralPartialEq for CLValue