Struct Message

pub struct Message { /* private fields */ }

Message that was emitted by an addressable entity during execution.

Implementations

impl Message

pub fn new( source: EntityAddr, message: MessagePayload, topic_name: String, topic_name_hash: TopicNameHash, topic_index: u32, block_index: u64, ) -> Self

Creates new instance of Message with the specified source and message payload.

pub fn entity_addr(&self) -> &EntityAddr

Returns a reference to the identity of the entity that produced the message.

pub fn payload(&self) -> &MessagePayload

Returns a reference to the payload of the message.

pub fn topic_name(&self) -> &str

Returns a reference to the name of the topic on which the message was emitted on.

pub fn topic_name_hash(&self) -> &TopicNameHash

Returns a reference to the hash of the name of the topic.

pub fn topic_index(&self) -> u32

Returns the index of the message in the topic.

pub fn block_index(&self) -> u64

Returns the index of the message relative to other messages emitted in the block.

pub fn message_key(&self) -> Key

Returns a new Key::Message based on the information in the message. This key can be used to query the checksum record for the message in global state.

pub fn topic_key(&self) -> Key

Returns a new Key::Message based on the information in the message. This key can be used to query the control record for the topic of this message in global state.

pub fn checksum(&self) -> Result<MessageChecksum, Error>

Returns the checksum of the message.

pub fn random(rng: &mut TestRng) -> Self

Available on crate feature testing only.

Returns a random Message.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for Message

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 Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

Available on crate feature std only.

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

Deserialize this value from the given Serde deserializer.

impl Distribution<Message> for Standard

Available on crate feature testing only.

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

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 FromBytes for Message

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 Message

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 Message

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

Available on crate feature std only.

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

Serialize this value into the given Serde serializer.

impl ToBytes for Message

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 into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

impl Eq for Message

impl StructuralPartialEq for Message