Struct Package

pub struct Package { /* private fields */ }

Entity definition, metadata, and security container.

Implementations

impl Package

pub fn new( versions: EntityVersions, disabled_versions: BTreeSet<EntityVersionKey>, groups: Groups, lock_status: PackageStatus, ) -> Self

Create new Package (with no versions) from given access key.

pub fn enable_version(&mut self, entity_addr: EntityAddr) -> Result<(), Error>

Enable the entity version corresponding to the given hash (if it exists).

pub fn groups_mut(&mut self) -> &mut Groups

Get the mutable group definitions for this entity.

pub fn groups(&self) -> &Groups

Get the group definitions for this entity.

pub fn add_group(&mut self, group: Group, urefs: BTreeSet<URef>)

Adds new group to this entity.

pub fn lookup_entity_hash( &self, entity_version_key: EntityVersionKey, ) -> Option<&EntityAddr>

Lookup the entity hash for a given entity version (if present)

pub fn is_version_missing(&self, entity_version_key: EntityVersionKey) -> bool

Checks if the given entity version exists.

pub fn is_version_enabled(&self, entity_version_key: EntityVersionKey) -> bool

Checks if the given entity version exists and is available for use.

pub fn is_entity_enabled(&self, entity_hash: &EntityAddr) -> bool

Returns true if the given entity hash exists and is enabled.

pub fn insert_entity_version( &mut self, protocol_version_major: u32, entity_hash: EntityAddr, ) -> EntityVersionKey

Insert a new entity version; the next sequential version number will be issued.

pub fn disable_entity_version( &mut self, entity_hash: EntityAddr, ) -> Result<(), Error>

Disable the entity version corresponding to the given hash (if it exists).

pub fn versions(&self) -> &EntityVersions

Returns reference to all of this entity’s versions.

pub fn enabled_versions(&self) -> EntityVersions

Returns all of this entity’s enabled entity versions.

pub fn versions_mut(&mut self) -> &mut EntityVersions

Returns mutable reference to all of this entity’s versions (enabled and disabled).

pub fn take_versions(self) -> EntityVersions

Consumes the object and returns all of this entity’s versions (enabled and disabled).

pub fn disabled_versions(&self) -> &BTreeSet<EntityVersionKey>

Returns all of this entity’s disabled versions.

pub fn disabled_versions_mut(&mut self) -> &mut BTreeSet<EntityVersionKey>

Returns mut reference to all of this entity’s disabled versions.

pub fn remove_group(&mut self, group: &Group) -> bool

Removes a group from this entity (if it exists).

pub fn next_entity_version_for(&self, protocol_version: u32) -> EntityVersion

Gets the next available entity version for the given protocol version

pub fn current_entity_version_for( &self, protocol_version: u32, ) -> EntityVersionKey

pub fn current_entity_version(&self) -> Option<EntityVersionKey>

Return the entity version key for the newest enabled entity version.

pub fn current_entity_hash(&self) -> Option<EntityAddr>

Return the entity hash for the newest enabled entity version.

pub fn is_locked(&self) -> bool

Return the lock status of the entity package.

pub fn get_lock_status(&self) -> PackageStatus

Return the package status itself

Trait Implementations

impl CLTyped for Package

fn cl_type() -> CLType

The CLType of Self.

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 DataSize for Package

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 Package

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

Formats the value using the given formatter.

impl Default for Package

fn default() -> Package

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 From<ContractPackage> for Package

fn from(value: ContractPackage) -> Self

Converts to this type from the input type.

impl From<Package> for StoredValue

fn from(value: Package) -> StoredValue

Converts to this type from the input type.

impl FromBytes for Package

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 JsonSchema for Package

fn schema_name() -> String

The name of the generated JSON Schema.

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

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

fn json_schema(generator: &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.

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 ToBytes for Package

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

Serializes &self 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.

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

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl TryFrom<StoredValue> for Package

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 Package

impl StructuralPartialEq for Package