Struct URef

pub struct URef(/* private fields */);

Represents an unforgeable reference, containing an address in the network’s global storage and the AccessRights of the reference.

A URef can be used to index entities such as CLValues, or smart contracts.

Implementations

impl URef

pub const fn new(address: URefAddr, access_rights: AccessRights) -> Self

Constructs a URef from an address and access rights.

pub fn addr(&self) -> URefAddr

Returns the address of this URef.

pub fn access_rights(&self) -> AccessRights

Returns the access rights of this URef.

pub fn with_access_rights(self, access_rights: AccessRights) -> Self

Returns a new URef with the same address and updated access rights.

pub fn remove_access_rights(self) -> Self

Removes the access rights from this URef.

pub fn is_readable(self) -> bool

Returns true if the access rights are Some and is_readable is true for them.

pub fn into_read(self) -> URef

Returns a new URef with the same address and AccessRights::READ permission.

pub fn into_write(self) -> URef

Returns a new URef with the same address and AccessRights::WRITE permission.

pub fn into_add(self) -> URef

Returns a new URef with the same address and AccessRights::ADD permission.

pub fn into_read_add_write(self) -> URef

Returns a new URef with the same address and AccessRights::READ_ADD_WRITE permission.

pub fn into_read_write(self) -> URef

Returns a new URef with the same address and AccessRights::READ_WRITE permission.

pub fn is_writeable(self) -> bool

Returns true if the access rights are Some and is_writeable is true for them.

pub fn is_addable(self) -> bool

Returns true if the access rights are Some and is_addable is true for them.

pub fn to_formatted_string(self) -> String

Formats the address and access rights of the URef in a unique way that could be used as a name when storing the given URef in a global state.

pub fn from_formatted_str(input: &str) -> Result<Self, FromStrError>

Parses a string formatted as per Self::to_formatted_string() into a URef.

pub fn disable_access_rights(&mut self, access_rights: AccessRights)

Removes specific access rights from this URef if present.

Trait Implementations

impl CLTyped for URef

fn cl_type() -> CLType

The CLType of Self.

impl Clone for URef

fn clone(&self) -> URef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for URef

const IS_DYNAMIC: bool = false

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 URef

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

Formats the value using the given formatter.

impl Default for URef

fn default() -> URef

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for URef

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

Deserialize this value from the given Serde deserializer.

impl Display for URef

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

Formats the value using the given formatter.

impl Distribution<URef> for Standard

Available on crate feature testing only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> URef

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<URef> for DelegatorKind

fn from(value: URef) -> Self

Converts to this type from the input type.

impl From<URef> for Key

fn from(uref: URef) -> Key

Converts to this type from the input type.

impl From<URef> for TransferTarget

fn from(uref: URef) -> Self

Converts to this type from the input type.

impl FromBytes for URef

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 URef

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 URef

Available on crate feature json-schema only.

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 URef

fn cmp(&self, other: &URef) -> 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 URef

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

fn partial_cmp(&self, other: &URef) -> 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 URef

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

Serialize this value into the given Serde serializer.

impl ToBytes for URef

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<Key> for URef

type Error = ApiError

The type returned in the event of a conversion error.

fn try_from(key: Key) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for URef

impl Eq for URef

impl StructuralPartialEq for URef