Struct Package

#[non_exhaustive]
pub struct Package {
    pub storage_id: Option<String>,
    pub original_id: Option<String>,
    pub version: Option<u64>,
    pub modules: Vec<Module>,
    pub type_origins: Vec<TypeOrigin>,
    pub linkage: Vec<Linkage>,
}

A Move Package

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

storage_id: Option<String>

The PackageId of this package

A package’s storage_id is the Sui ObjectId of the package on-chain. Outside of system packages the storage_id for every package version is different.

original_id: Option<String>

The PackageId of the first published version of this package.

A package’s original_id (sometimes also called its runtime_id) is the storage_id of the first version of this package that has been published. The original_id/runtime_id is stable across all versions of the package and does not ever change.

version: Option<u64>

The version of this package

modules: Vec<Module>

The modules defined by this package

type_origins: Vec<TypeOrigin>

List of datatype origins for mapping datatypes to a package version where it was first defined

linkage: Vec<Linkage>

The package’s transitive dependencies as a mapping from the package’s runtime Id (the Id it is referred to by in other packages) to its storage Id (the Id it is loaded from on chain).

Implementations

impl Package

pub const STORAGE_ID_FIELD: &'static MessageField

pub const ORIGINAL_ID_FIELD: &'static MessageField

pub const VERSION_FIELD: &'static MessageField

pub const MODULES_FIELD: &'static MessageField

pub const TYPE_ORIGINS_FIELD: &'static MessageField

pub const LINKAGE_FIELD: &'static MessageField

impl Package

pub fn path_builder() -> PackageFieldPathBuilder

impl Package

pub const fn const_default() -> Self

pub fn storage_id_opt_mut(&mut self) -> Option<&mut String>

If storage_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn storage_id_mut(&mut self) -> &mut String

Returns a mutable reference to storage_id. If the field is unset, it is first initialized with the default value.

pub fn storage_id_opt(&self) -> Option<&str>

If storage_id is set, returns Some with the value; otherwise returns None.

pub fn set_storage_id<T: Into<String>>(&mut self, field: T)

Sets storage_id with the provided value.

pub fn with_storage_id<T: Into<String>>(self, field: T) -> Self

Sets storage_id with the provided value.

pub fn original_id_opt_mut(&mut self) -> Option<&mut String>

If original_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn original_id_mut(&mut self) -> &mut String

Returns a mutable reference to original_id. If the field is unset, it is first initialized with the default value.

pub fn original_id_opt(&self) -> Option<&str>

If original_id is set, returns Some with the value; otherwise returns None.

pub fn set_original_id<T: Into<String>>(&mut self, field: T)

Sets original_id with the provided value.

pub fn with_original_id<T: Into<String>>(self, field: T) -> Self

Sets original_id with the provided value.

pub fn version_opt_mut(&mut self) -> Option<&mut u64>

If version is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn version_mut(&mut self) -> &mut u64

Returns a mutable reference to version. If the field is unset, it is first initialized with the default value.

pub fn version_opt(&self) -> Option<u64>

If version is set, returns Some with the value; otherwise returns None.

pub fn set_version<T: Into<u64>>(&mut self, field: T)

Sets version with the provided value.

pub fn with_version<T: Into<u64>>(self, field: T) -> Self

Sets version with the provided value.

pub fn modules(&self) -> &[Module]

Returns the value of modules, or the default value if modules is unset.

pub fn modules_mut(&mut self) -> &mut Vec<Module>

Returns a mutable reference to modules. If the field is unset, it is first initialized with the default value.

pub fn set_modules(&mut self, field: Vec<Module>)

Sets modules with the provided value.

pub fn with_modules(self, field: Vec<Module>) -> Self

Sets modules with the provided value.

pub fn type_origins(&self) -> &[TypeOrigin]

Returns the value of type_origins, or the default value if type_origins is unset.

pub fn type_origins_mut(&mut self) -> &mut Vec<TypeOrigin>

Returns a mutable reference to type_origins. If the field is unset, it is first initialized with the default value.

pub fn set_type_origins(&mut self, field: Vec<TypeOrigin>)

Sets type_origins with the provided value.

pub fn with_type_origins(self, field: Vec<TypeOrigin>) -> Self

Sets type_origins with the provided value.

pub fn linkage(&self) -> &[Linkage]

Returns the value of linkage, or the default value if linkage is unset.

pub fn linkage_mut(&mut self) -> &mut Vec<Linkage>

Returns a mutable reference to linkage. If the field is unset, it is first initialized with the default value.

pub fn set_linkage(&mut self, field: Vec<Linkage>)

Sets linkage with the provided value.

pub fn with_linkage(self, field: Vec<Linkage>) -> Self

Sets linkage with the provided value.

impl Package

pub fn storage_id(&self) -> &str

Returns the value of storage_id, or the default value if storage_id is unset.

pub fn original_id(&self) -> &str

Returns the value of original_id, or the default value if original_id is unset.

pub fn version(&self) -> u64

Returns the value of version, or the default value if version is unset.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Default for Package

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Package

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Package

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for Package

const FIELDS: &'static [&'static MessageField]

impl PartialEq for Package

fn eq(&self, other: &Package) -> 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 Serialize for Package

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 Package