Struct diem_types::event::EventKey

pub struct EventKey(_);

A struct that represents a globally unique id for an Event stream that a user can listen to. By design, the lower part of EventKey is the same as account address.

Implementations

impl EventKey

pub fn new(key: [u8; 24]) -> Self

Construct a new EventKey from a byte array slice.

pub const LENGTH: usize

The number of bytes in an EventKey.

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

Get the byte representation of the event key.

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

Convert event key into a byte array.

pub fn get_creator_address(&self) -> AccountAddress

Get the account address part in this event key

pub fn get_creation_number(&self) -> u64

If this is the ith EventKeycreated byget_creator_address(), return i`

pub fn random() -> Self

Create a random event key for testing

pub fn new_from_address(addr: &AccountAddress, salt: u64) -> Self

Create a unique handle by using an AccountAddress and a counter.

pub fn from_hex<T: AsRef<[u8]>>(hex: T) -> Result<Self, EventKeyParseError>

pub fn from_bytes<T: AsRef<[u8]>>(bytes: T) -> Result<Self, EventKeyParseError>

Trait Implementations

impl Arbitrary for EventKey

type Parameters = <[u8; 24] as Arbitrary>::Parameters

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

type Strategy = Map<<[u8; 24] as Arbitrary>::Strategy, fn(_: [u8; 24]) -> Self>

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

fn arbitrary_with(_top: Self::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 EventKey

fn clone(&self) -> EventKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventKey

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

Deserialize this value from the given Serde deserializer.

impl Display for EventKey

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

Formats the value using the given formatter.

impl From<&'_ EventKey> for [u8; 24]

fn from(event_key: &EventKey) -> Self

Performs the conversion.

impl From<EventKey> for [u8; 24]

fn from(event_key: EventKey) -> Self

Performs the conversion.

impl FromStr for EventKey

type Err = EventKeyParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, EventKeyParseError>

Parses a string s to return a value of this type.

impl Hash for EventKey

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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for EventKey

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

Formats the value using the given formatter.

impl Ord for EventKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<EventKey> for EventKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<EventKey> for EventKey

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for EventKey

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ [u8]> for EventKey

fn try_from(bytes: &[u8]) -> Result<EventKey, EventKeyParseError>

Tries to convert the provided byte array into Event Key.

type Error = EventKeyParseError

The type returned in the event of a conversion error.

impl Copy for EventKey

impl Eq for EventKey

impl StructuralEq for EventKey

impl StructuralPartialEq for EventKey