Struct StreamOptions 

pub struct StreamOptions {
    pub poll_interval: Duration,
    pub buffer_size: usize,
    pub include_errors: bool,
    pub max_consecutive_failures: Option<u32>,
}

Options for reading streams.

Use the builder pattern for convenient configuration:

let options = StreamOptions::builder()
    .poll_interval(Duration::from_secs(5))
    .include_errors(true)
    .max_consecutive_failures(5)
    .build();

Fields

poll_interval: Duration

Polling interval for devices that don’t support notifications. Default: 1 second.

buffer_size: usize

Buffer size for the reading channel. Default: 16 readings.

include_errors: bool

Whether to include failed reads in the stream.

When false (default), read errors are logged but not sent to the stream. When true, errors are sent as Err(Error) items, allowing the consumer to detect and handle connection issues.

Recommendation: Set to true for applications that need to detect disconnections or errors in real-time.

max_consecutive_failures: Option<u32>

Maximum consecutive failures before auto-closing the stream.

When set to Some(n), the stream will automatically close after n consecutive read failures, indicating a likely disconnection. When None (default), the stream will continue indefinitely regardless of failures.

Recommendation: Set to Some(5) or similar for production use to prevent indefinite polling of a disconnected device.

Implementations

impl StreamOptions

pub fn builder() -> StreamOptionsBuilder

Create a new builder for StreamOptions.

pub fn with_interval(interval: Duration) -> Self

Create options with a specific poll interval.

pub fn validate(&self) -> Result<()>

Validate the options and return an error if invalid.

Checks that:

• buffer_size is > 0
• poll_interval is > 0

Trait Implementations

impl Clone for StreamOptions

fn clone(&self) -> StreamOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamOptions

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

Formats the value using the given formatter.

impl Default for StreamOptions

fn default() -> Self

Returns the “default value” for a type.