Embassy
embassy-nrf

Crates

git

Versions

nrf52805

Flavors

pub struct BufferedUarte<'d, U: UarteInstance, T: TimerInstance> { /* private fields */ }
Expand description

Buffered UARTE driver.

Implementations§

source§

impl<'d, U: UarteInstance, T: TimerInstance> BufferedUarte<'d, U, T>

source

pub fn new( uarte: impl Peripheral<P = U> + 'd, timer: impl Peripheral<P = T> + 'd, ppi_ch1: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_ch2: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_group: impl Peripheral<P = impl Group> + 'd, _irq: impl Binding<U::Interrupt, InterruptHandler<U>> + 'd, rxd: impl Peripheral<P = impl GpioPin> + 'd, txd: impl Peripheral<P = impl GpioPin> + 'd, config: Config, rx_buffer: &'d mut [u8], tx_buffer: &'d mut [u8] ) -> Self

Create a new BufferedUarte without hardware flow control.

§Panics

Panics if rx_buffer.len() is odd.

source

pub fn new_with_rtscts( uarte: impl Peripheral<P = U> + 'd, timer: impl Peripheral<P = T> + 'd, ppi_ch1: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_ch2: impl Peripheral<P = impl ConfigurableChannel> + 'd, ppi_group: impl Peripheral<P = impl Group> + 'd, _irq: impl Binding<U::Interrupt, InterruptHandler<U>> + 'd, rxd: impl Peripheral<P = impl GpioPin> + 'd, txd: impl Peripheral<P = impl GpioPin> + 'd, cts: impl Peripheral<P = impl GpioPin> + 'd, rts: impl Peripheral<P = impl GpioPin> + 'd, config: Config, rx_buffer: &'d mut [u8], tx_buffer: &'d mut [u8] ) -> Self

Create a new BufferedUarte with hardware flow control (RTS/CTS)

§Panics

Panics if rx_buffer.len() is odd.

source

pub fn set_baudrate(&mut self, baudrate: Baudrate)

Adjust the baud rate to the provided value.

source

pub fn split(self) -> (BufferedUarteRx<'d, U, T>, BufferedUarteTx<'d, U>)

Split the UART in reader and writer parts.

This allows reading and writing concurrently from independent tasks.

source

pub fn split_by_ref( &mut self ) -> (&mut BufferedUarteRx<'d, U, T>, &mut BufferedUarteTx<'d, U>)

Split the UART in reader and writer parts, by reference.

The returned halves borrow from self, so you can drop them and go back to using the “un-split” self. This allows temporarily splitting the UART.

source

pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

source

pub async fn fill_buf(&mut self) -> Result<&[u8], Error>

Return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

source

pub fn consume(&mut self, amt: usize)

Tell this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to fill_buf.

source

pub async fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this writer, returning how many bytes were written.

source

pub async fn flush(&mut self) -> Result<(), Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

Trait Implementations§

source§

impl<'d, U: UarteInstance, T: TimerInstance> BufRead for BufferedUarte<'d, U, T>

source§

async fn fill_buf(&mut self) -> Result<&[u8], Self::Error>

Return the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more
source§

fn consume(&mut self, amt: usize)

Tell this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to fill_buf.
source§

impl<'d, U: UarteInstance, T: TimerInstance> ErrorType for BufferedUarte<'d, U, T>

§

type Error = Error

Error type of all the IO operations on this type.
source§

impl<'d, U: UarteInstance, T: TimerInstance> Read for BufferedUarte<'d, U, T>

source§

async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read. Read more
source§

async fn read_exact( &mut self, buf: &mut [u8] ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf. Read more
source§

impl<'d, U: UarteInstance, T: TimerInstance> Write for BufferedUarte<'d, U, T>

source§

async fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written. Read more
source§

async fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.
source§

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer. Read more
source§

impl<'d, U: UarteInstance, T: TimerInstance> Unpin for BufferedUarte<'d, U, T>

Auto Trait Implementations§

§

impl<'d, U, T> Freeze for BufferedUarte<'d, U, T>
where T: Freeze, U: Freeze,

§

impl<'d, U, T> RefUnwindSafe for BufferedUarte<'d, U, T>

§

impl<'d, U, T> Send for BufferedUarte<'d, U, T>

§

impl<'d, U, T> Sync for BufferedUarte<'d, U, T>
where T: Sync, U: Sync,

§

impl<'d, U, T> !UnwindSafe for BufferedUarte<'d, U, T>

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> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

source§

fn lossy_into(self) -> Dst

Performs the conversion.
source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

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

§

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>,

§

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.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.