Struct EventLogEntry

pub struct EventLogEntry {
    pub kind: EventKind,
    pub module: Option<(ModuleKind, ModuleInstanceId)>,
    ts_usecs: u64,
    pub payload: Vec<u8>,
}

Fields

kind: EventKind

Type/kind of the event

Any part of the client is free to self-allocate identifier, denoting a certain kind of an event. Notably one event kind have multiple instances. E.g. “successful wallet deposit” can be an event kind, and it can happen multiple times with different payloads.

module: Option<(ModuleKind, ModuleInstanceId)>

To prevent accidental conflicts between kinds, a module kind the given event kind belong is used as well.

Note: the meaning of this field is mostly about which part of the code defines this event kind. Oftentime a core (non-module)-defined event will refer in some way to a module. It should use a separate module_id field in the payload, instead of this field.

ts_usecs: u64

Timestamp in microseconds after unix epoch

payload: Vec<u8>

Event-kind specific payload, typically encoded as a json string for flexibility.

Trait Implementations

impl Debug for EventLogEntry

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

Formats the value using the given formatter.

impl Decodable for EventLogEntry

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl Encodable for EventLogEntry

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

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

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.