Struct mavio::AsyncReceiver

pub struct AsyncReceiver<R: AsyncRead + Unpin, V: MaybeVersioned> { /* private fields */ }

Receives MAVLink frames asynchronously.

Receives MAVLink frames from an instance of AsyncRead.

Implementations

impl<R: AsyncRead + Unpin> AsyncReceiver<R, Versionless>

pub fn new<V: MaybeVersioned>(reader: R) -> AsyncReceiver<R, V>

Default constructor.

pub fn versionless(reader: R) -> AsyncReceiver<R, Versionless>

Create a MAVLink version agnostic receiver.

Creates a protocol-agnostic receiver which will look up for both MAVLink 1 and MAVLink 2 frames.

If you want a receiver restricted to a specific MAVLink protocol version, use AsyncReceiver::versioned.

If you want to instantiate a generic receiver, use AsyncReceiver::new.

pub fn versioned<Version: Versioned>( reader: R, version: Version ) -> AsyncReceiver<R, Version>

Create a receiver specific to a particular MAVLink protocol version.

Same as AsyncReceiver::new::<V1> / AsyncReceiver::new::<V2> but with an explicit version marker as a parameter.

Since versioned receiver will look up for MAVLink frames starting with a specific MavSTX magic byte, it may behave incorrectly, if the incoming stream contains frames of a different protocol version. If this is the case, it is preferred to construct versionless receiver by AsyncReceiver::new and then attempt to convert incoming frames into a specific protocol version with Frame::try_into_versioned.

impl<R: AsyncRead + Unpin, V: MaybeVersioned> AsyncReceiver<R, V>

pub async fn recv(&mut self) -> Result<Frame<V>>

Receives MAVLink Frame.

Blocks until a valid MAVLink frame received.

Versioned receiver accepts only frames of a specific MAVLink protocol version.

Versionless receiver accepts both MAVLink 1 and MAVLink 2 frames.

Trait Implementations

impl<R: Clone + AsyncRead + Unpin, V: Clone + MaybeVersioned> Clone for AsyncReceiver<R, V>

fn clone(&self) -> AsyncReceiver<R, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug + AsyncRead + Unpin, V: Debug + MaybeVersioned> Debug for AsyncReceiver<R, V>

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

Formats the value using the given formatter.