Struct StreamOptions 

pub struct StreamOptions<F: StreamFormat> { /* private fields */ }

Configuration options for GPS data streams

This struct allows configuring various aspects of the data stream, such as enabling specific data types or formatting options.

Use the format-specific constructors (StreamOptions::json(), etc.) to create instances with appropriate defaults.

Implementations

impl<F: StreamFormat> StreamOptions<F>

pub fn scaled(self, enable: bool) -> Self

Enables or disables scaled output

When enabled, GPSD applies scaling to output values. This affects units and precision of reported values.

pub fn split24(self, enable: bool) -> Self

Enables or disables split24 mode

When enabled, AIS type 24 messages are split into separate part A and part B messages.

impl StreamOptions<Json>

pub fn json() -> StreamOptions<Json>

Creates stream options for JSON format output

Returns a configuration for receiving structured GPS data as JSON messages.

pub fn pps(self, enable: bool) -> Self

Enables or disables PPS (Pulse Per Second) messages

When enabled, the stream will include PPS timing messages if the GPS receiver supports precision timing.

pub fn timing(self, enable: bool) -> Self

Enables or disables timing information

When enabled, messages include detailed timing information about when data was received and processed.

impl StreamOptions<Nmea>

pub fn nmea() -> StreamOptions<Nmea>

Creates stream options for NMEA format output

Returns a configuration for receiving raw NMEA 0183 sentences from the GPS receiver.

pub fn device<S: AsRef<str>>(self, device: S) -> Self

Specifies a particular GPS device to stream from

Arguments

• device - Path to the GPS device (e.g., “/dev/ttyUSB0”)

impl StreamOptions<Raw>

pub fn raw() -> StreamOptions<Raw>

Creates stream options for raw format output

Returns a configuration for receiving raw binary data from the GPS receiver.

pub fn hex_dump(self, enable: bool) -> Self

Configures hex dump mode for raw data

Arguments

• enable - true for hex dump format, false for binary

pub fn device<S: AsRef<str>>(self, device: S) -> Self

Specifies a particular GPS device to stream from

Arguments

• device - Path to the GPS device (e.g., “/dev/ttyUSB0”)

Trait Implementations

impl<F: Clone + StreamFormat> Clone for StreamOptions<F>

fn clone(&self) -> StreamOptions<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + StreamFormat> Debug for StreamOptions<F>

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

Formats the value using the given formatter.