Struct MoveStruct 

pub struct MoveStruct { /* private fields */ }

A move struct

BCS

The BCS serialized form for this type is defined by the following ABNF:

move-struct = compressed-struct-tag u64 bytes

compressed-struct-tag = other-struct-type / gas-coin-type / staked-iota-type / coin-type
other-struct-type     = %d00 struct-tag
gas-coin-type         = %d01
staked-iota-type      = %d02
coin-type             = %d03 type-tag

; The first 32 bytes of the `bytes` contents are the object's object-id.

Implementations

impl MoveStruct

pub fn new( object_type: MoveObjectType, version: Version, contents: Vec<u8>, ) -> Result<Self, MoveStructContentsError>

Creates a new MoveStruct.

Errors

Returns an error if contents is shorter than ObjectId::LENGTH bytes, since every Move object must contain its ObjectId as the leading bytes.

pub fn object_type(&self) -> &MoveObjectType

Returns the type of this Move object.

pub fn struct_tag(&self) -> &StructTag

Returns the object type as a StructTag reference.

pub fn is_struct_tag(&self, s: &StructTag) -> bool

Returns true if the object’s type matches the given StructTag.

pub fn id(&self) -> ObjectId

Returns the object’s ID, extracted from the BCS-encoded contents.

This is always valid because the constructor guarantees that contents is at least ObjectId::LENGTH bytes long.

pub fn version(&self) -> Version

Returns the version (lamport timestamp) of this object.

pub fn set_version(&mut self, version: Version)

Sets the version (lamport timestamp) of this object.

pub fn set_object_type(&mut self, object_type: MoveObjectType)

Sets the type of this object.

The caller must ensure the existing contents are a valid BCS encoding of the new object_type; this is not verified.

pub fn contents(&self) -> &[u8]

Returns the raw BCS-encoded contents of this object.

pub fn set_contents( &mut self, contents: Vec<u8>, ) -> Result<(), MoveStructContentsError>

Replaces the BCS-encoded contents of this object.

The caller must ensure the new contents are a valid BCS encoding of the object’s object_type; this is not verified.

Errors

Returns an error if contents is shorter than ObjectId::LENGTH bytes.

pub fn into_contents(self) -> Vec<u8>

Consumes the object and returns the raw BCS-encoded contents.

pub fn type_tag(&self) -> TypeTag

Returns the object type as a TypeTag.

pub fn into_parts(self) -> (MoveObjectType, Version, Vec<u8>)

Consumes the object and returns its type, version, and raw contents.

pub fn to_rust<'de, T: Deserialize<'de>>(&'de self) -> Result<T, Error>

Available on crate feature serde only.

Deserializes the BCS-encoded contents into a Rust type.

Trait Implementations

impl Arbitrary for MoveStruct

Available on crate feature proptest only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<MoveStruct>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( args_shared: <Self as Arbitrary>::Parameters, ) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MoveStruct

fn clone(&self) -> MoveStruct

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MoveStruct

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MoveStruct

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MoveStruct

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

Formats the value using the given formatter.

impl Eq for MoveStruct

impl Hash for MoveStruct

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 PartialEq for MoveStruct

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MoveStruct

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MoveStruct