Enum CommandPolicy 

pub enum CommandPolicy {
    PublishState,
    Manual,
}

Determines how an entity handles commands received from Home Assistant.

This policy controls whether an entity automatically publishes its state when it receives a command from Home Assistant, or if the application should handle state updates manually.

Variants

PublishState (Default)

When a command is received from Home Assistant, the entity automatically:

1. Updates its internal state to match the command value
2. Publishes the new state back to Home Assistant

This is useful for simple entities where the command should immediately be reflected as the current state, such as:

• A switch that turns on/off immediately when commanded
• A number input that updates its value when changed in the UI

Manual

When a command is received from Home Assistant, the entity:

1. Stores the command for the application to read via wait() or command()
2. Does NOT automatically update or publish the state

The application must manually update the entity’s state after processing the command. This is useful when:

• The command triggers an action that may fail (e.g., turning on a motor)
• The actual state may differ from the commanded state
• You need to validate or transform the command before applying it

Examples

Auto-publish (default)

let config = SwitchConfig {
    command_policy: CommandPolicy::PublishState, // or just use default
    ..Default::default()
};
// When Home Assistant sends "ON", the switch state automatically becomes "ON"

Manual control

let config = SwitchConfig {
    command_policy: CommandPolicy::Manual,
    ..Default::default()
};

loop {
    let command = switch.wait().await;

    // Try to perform the action
    if turn_on_motor().await.is_ok() {
        // Only update state if the action succeeded
        switch.set(command);
    }
}

Variants

PublishState

Automatically publish the entity’s state when a command is received.

Manual

Do not automatically publish state. The application must manually update the state.

Trait Implementations

impl Clone for CommandPolicy

fn clone(&self) -> CommandPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandPolicy

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

Formats the value using the given formatter.

impl Default for CommandPolicy

fn default() -> CommandPolicy

Returns the “default value” for a type.

impl PartialEq for CommandPolicy

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

impl Eq for CommandPolicy

impl StructuralPartialEq for CommandPolicy