Struct ProtocolStateDelta 

pub struct ProtocolStateDelta {
    pub component_id: String,
    pub updated_attributes: HashMap<String, Bytes>,
    pub deleted_attributes: HashSet<String>,
}

Represents a change in protocol state.

Fields

component_id: String

updated_attributes: HashMap<String, Bytes>

deleted_attributes: HashSet<String>

Implementations

impl ProtocolStateDelta

pub fn merge(&mut self, other: &Self)

Merges ‘other’ into ‘self’.

During merge of these deltas a special situation can arise when an attribute is present in self.deleted_attributes and `other.update_attributes``. If we would just merge the sets of deleted attributes or vice versa, it would be ambiguous and potential lead to a deletion of an attribute that should actually be present, or retention of an actually deleted attribute.

This situation is handled the following way:

- If an attribute is deleted and in the next message recreated, it is removed from the
  set of deleted attributes and kept in updated_attributes. This way it's temporary
  deletion is never communicated to the final receiver.
- If an attribute was updated and is deleted in the next message, it is removed from
  updated attributes and kept in deleted. This way the attributes temporary update (or
  potentially short-lived existence) before its deletion is never communicated to the
  final receiver.

Trait Implementations

impl Clone for ProtocolStateDelta

fn clone(&self) -> ProtocolStateDelta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolStateDelta

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

Formats the value using the given formatter.

impl Default for ProtocolStateDelta

fn default() -> ProtocolStateDelta

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtocolStateDelta

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ProtocolComponentStateDelta> for ProtocolStateDelta

fn from(value: ProtocolComponentStateDelta) -> Self

Converts to this type from the input type.

impl PartialEq for ProtocolStateDelta

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for ProtocolStateDelta

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl StructuralPartialEq for ProtocolStateDelta