Skip to main content

RxStream

Struct RxStream 

Source
pub struct RxStream { /* private fields */ }
Expand description

Owned HackRF receive stream.

start selects RX while the radio is off. read only consumes the owned RX queue and never switches direction or takes the lifecycle mutex.

Implementations§

Source§

impl RxStream

Source

pub fn start(&mut self) -> impl MaybeFuture<Output = Result<()>> + '_

Start or resume RX while the radio is off.

Returns Error::Busy when TX is active or any control transition is in progress. Calling start on an already-running RX stream succeeds without changing hardware state.

Source

pub fn read<'a>( &'a mut self, out: &'a mut [Complex32], timeout: Option<Duration>, ) -> impl MaybeFuture<Output = Result<usize>> + 'a

Read normalized complex IQ samples from a started RX stream.

Blocking operation fills the output until its total timeout expires; None waits indefinitely. Awaited operation ignores the timeout and consumes buffered data or one new USB completion.

Source

pub fn stop(&mut self) -> impl MaybeFuture<Output = Result<StreamingStats>> + '_

Stop RX, turn the radio off, and return counters for this run.

A successful stop retains the RX queue so a later Self::start can resume it without submitting a second queue. Drop the stream for final best-effort queue cleanup. A stream I/O failure turns the radio off, closes the queue, and permanently invalidates this stream; drop it and create a new RX stream before starting again. On WebUSB, dropping an RX stream whose queue has started is terminal for RX on this device session; drop and reopen the device instead.

Trait Implementations§

Source§

impl Drop for RxStream

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.