Skip to main content

MessageKind

Enum MessageKind 

Source
#[non_exhaustive]
pub enum MessageKind {
Show 36 variants Handshake, HandshakeResponse, ResourceManagerDetails, SelectControlType, SessionRequest, ReceptionStatus, InstructionStatusUpdate, PowerMeasurement, PowerForecast, RevokeObject, PebcPowerConstraints, PebcEnergyConstraint, PebcInstruction, PpbcPowerProfileDefinition, PpbcPowerProfileStatus, PpbcScheduleInstruction, PpbcStartInterruptionInstruction, PpbcEndInterruptionInstruction, OmbcSystemDescription, OmbcStatus, OmbcTimerStatus, OmbcInstruction, FrbcSystemDescription, FrbcStorageStatus, FrbcActuatorStatus, FrbcTimerStatus, FrbcLeakageBehaviour, FrbcUsageForecast, FrbcFillLevelTargetProfile, FrbcInstruction, DdbcSystemDescription, DdbcActuatorStatus, DdbcTimerStatus, DdbcAverageDemandRateForecast, DdbcPresentDemandStatus, DdbcInstruction,
}
Expand description

Every S2 message type, without the payload.

MessageKind is Copy and fieldless, which is what makes the session’s allowed-message table a lookup rather than a match over 36 arms.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Handshake

§

HandshakeResponse

§

ResourceManagerDetails

§

SelectControlType

§

SessionRequest

§

ReceptionStatus

§

InstructionStatusUpdate

§

PowerMeasurement

§

PowerForecast

§

RevokeObject

§

PebcPowerConstraints

§

PebcEnergyConstraint

§

PebcInstruction

§

PpbcPowerProfileDefinition

§

PpbcPowerProfileStatus

§

PpbcScheduleInstruction

§

PpbcStartInterruptionInstruction

§

PpbcEndInterruptionInstruction

§

OmbcSystemDescription

§

OmbcStatus

§

OmbcTimerStatus

§

OmbcInstruction

§

FrbcSystemDescription

§

FrbcStorageStatus

§

FrbcActuatorStatus

§

FrbcTimerStatus

§

FrbcLeakageBehaviour

§

FrbcUsageForecast

§

FrbcFillLevelTargetProfile

§

FrbcInstruction

§

DdbcSystemDescription

§

DdbcActuatorStatus

§

DdbcTimerStatus

§

DdbcAverageDemandRateForecast

§

DdbcPresentDemandStatus

§

DdbcInstruction

Implementations§

Source§

impl MessageKind

Source

pub const ALL: &'static [MessageKind]

Every message type this crate knows, in declaration order.

Source

pub const fn as_str(self) -> &'static str

The message_type string this kind has on the wire.

Source

pub fn from_wire(s: &str) -> Option<Self>

The kind a message_type string names, if this crate knows it.

Source§

impl MessageKind

Source

pub const fn control_type(self) -> Option<ControlType>

The control type this message belongs to, if any.

Source

pub const fn is_instruction(self) -> bool

Whether this message asks a Resource Manager to do something, and therefore earns an InstructionStatusUpdate as well as a ReceptionStatus.

Source

pub const fn sender(self) -> Option<EnergyManagementRole>

Which role sends this message.

SessionRequest and ReceptionStatus are sent by both, and so answer None.

Source

pub const fn exists_in(self, profile: WireProfile) -> bool

Whether the message exists in a given wire profile.

Only DDBC.PresentDemandStatus answers false for anything: it is new in v1.0.0.

Trait Implementations§

Source§

impl Clone for MessageKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for MessageKind

Source§

impl Debug for MessageKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for MessageKind

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for MessageKind

Source§

impl Hash for MessageKind

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for MessageKind

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for MessageKind

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for MessageKind

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for MessageKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more