Struct InventorySearchFlags 

pub struct InventorySearchFlags(/* private fields */);

Search flags used by inventory commands (for example 0x22 and 0xAA48).

For asynchronous inventory, protocol docs define extra semantics:

• bits 8..=11: rest ratio steps (0..=15)
• bit 15: heartbeat enable
• bit 14: auto-stop enable

Implementations

impl InventorySearchFlags

pub const fn new() -> Self

Create a default search flags value with all bits cleared.

pub const fn from_raw(raw: u16) -> Self

Create from the raw protocol value.

pub const fn raw(self) -> u16

Return the raw protocol value.

pub const fn async_rest_ratio_steps(self) -> u8

Extract asynchronous rest-ratio steps from bits 8..=11.

pub const fn async_heartbeat_enabled(self) -> bool

Return whether asynchronous heartbeat is enabled (bit 15).

pub const fn async_auto_stop_enabled(self) -> bool

Return whether asynchronous auto-stop is enabled (bit 14).

pub const fn embedded_command_enabled(self) -> bool

Return whether inventory embedded command mode is enabled (bit 2).

This bit is documented for command 0x22 and reused by asynchronous inventory start (0xAA48).

pub fn with_async_rest_ratio_steps( self, steps: u8, ) -> Result<Self, ProtocolError>

Set asynchronous rest-ratio steps (0..=15) in bits 8..=11.

pub const fn with_async_heartbeat(self, enabled: bool) -> Self

Set or clear asynchronous heartbeat enable (bit 15).

pub const fn with_async_auto_stop(self, enabled: bool) -> Self

Set or clear asynchronous auto-stop enable (bit 14).

pub const fn with_embedded_command(self, enabled: bool) -> Self

Set or clear inventory embedded command mode (bit 2).

Trait Implementations

impl Clone for InventorySearchFlags

fn clone(&self) -> InventorySearchFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InventorySearchFlags

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

Formats the value using the given formatter.

impl Default for InventorySearchFlags

fn default() -> Self

Returns the “default value” for a type.

impl From<InventorySearchFlags> for u16

fn from(value: InventorySearchFlags) -> Self

Converts to this type from the input type.

impl From<u16> for InventorySearchFlags

fn from(value: u16) -> Self

Converts to this type from the input type.

impl PartialEq for InventorySearchFlags

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

impl Eq for InventorySearchFlags

impl StructuralPartialEq for InventorySearchFlags