Struct console_api::resources::ResourceUpdate

pub struct ResourceUpdate {
    pub new_resources: Vec<Resource>,
    pub stats_update: HashMap<u64, Stats>,
    pub new_poll_ops: Vec<PollOp>,
    pub dropped_events: u64,
}

A resource state update.

Each ResourceUpdate contains any resource data that has changed since the last update. This includes:

• any new resources that were created since the last update
• the current stats for any resource whose stats changed since the last update
• any new poll ops that have been invoked on a resource

Fields

new_resources: Vec<Resource>

A list of new resources that were created since the last ResourceUpdate was sent.

stats_update: HashMap<u64, Stats>

Any resource stats that have changed since the last update.

new_poll_ops: Vec<PollOp>

A list of all new poll ops that have been invoked on resources since the last update.

dropped_events: u64

A count of how many resource events (e.g. polls, creation, etc) were not recorded because the application’s event buffer was at capacity.

If everything is working normally, this should be 0. If it is greater than 0, that may indicate that some data is missing from this update, and it may be necessary to increase the number of events buffered by the application to ensure that data loss is avoided.

If the application’s instrumentation ensures reliable delivery of events, this will always be 0.

Trait Implementations

impl Clone for ResourceUpdate

fn clone(&self) -> ResourceUpdate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceUpdate

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

Formats the value using the given formatter.

impl Default for ResourceUpdate

fn default() -> Self

Returns the “default value” for a type.

impl Message for ResourceUpdate

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ResourceUpdate

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ResourceUpdate