Struct diem_sdk::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]) -> EventKey

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, Global>

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 new_from_address(addr: &AccountAddress, salt: u64) -> EventKey

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

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

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

Trait Implementations

impl Clone for EventKey

pub 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

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for EventKey

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

Formats the value using the given formatter.

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

pub fn from(event_key: &EventKey) -> [u8; 24]

Performs the conversion.

impl From<EventKey> for [u8; 24]

pub fn from(event_key: EventKey) -> [u8; 24]

Performs the conversion.

impl FromStr for EventKey

type Err = EventKeyParseError

The associated error which can be returned from parsing.

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

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

impl Hash for EventKey

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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

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

Formats the value using the given formatter.

impl Ord for EventKey

pub 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

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

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

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

This method tests for !=.

impl PartialOrd<EventKey> for EventKey

pub 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

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

Serialize this value into the given Serde serializer.

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

pub 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