embassy-nrf

Crates

git

Versions

nrf9120-ns

Flavors

embassy_nrf::uarte

Struct Uarte

Source
pub struct Uarte<'d, T: Instance> { /* private fields */ }
Expand description

UARTE driver.

Implementations§

Source§

impl<'d, T: Instance> Uarte<'d, T>

Source

pub fn new( uarte: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, rxd: impl Peripheral<P = impl GpioPin> + 'd, txd: impl Peripheral<P = impl GpioPin> + 'd, config: Config, ) -> Self

Create a new UARTE without hardware flow control

Source

pub fn new_with_rtscts( uarte: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + '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, ) -> Self

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

Source

pub fn split(self) -> (UarteTx<'d, T>, UarteRx<'d, T>)

Split the Uarte into the transmitter and receiver parts.

This is useful to concurrently transmit and receive from independent tasks.

Source

pub fn split_by_ref(&mut self) -> (&mut UarteTx<'d, T>, &mut UarteRx<'d, T>)

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 fn split_with_idle<U: TimerInstance>( self, timer: impl Peripheral<P = U> + 'd, ppi_ch1: impl Peripheral<P = impl ConfigurableChannel + 'd> + 'd, ppi_ch2: impl Peripheral<P = impl ConfigurableChannel + 'd> + 'd, ) -> (UarteTx<'d, T>, UarteRxWithIdle<'d, T, U>)

Split the Uarte into the transmitter and receiver with idle support parts.

This is useful to concurrently transmit and receive from independent tasks.

Source

pub fn event_endtx(&self) -> Event<'_>

Return the endtx event for use with PPI

Source

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

Read bytes until the buffer is filled.

Source

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

Write all bytes in the buffer.

Source

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

Same as write but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

Source

pub fn blocking_read(&mut self, buffer: &mut [u8]) -> Result<(), Error>

Read bytes until the buffer is filled.

Source

pub fn blocking_write(&mut self, buffer: &[u8]) -> Result<(), Error>

Write all bytes in the buffer.

Source

pub fn blocking_write_from_ram(&mut self, buffer: &[u8]) -> Result<(), Error>

Same as blocking_write but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

Trait Implementations§

Source§

impl<'d, U: Instance> ErrorType for Uarte<'d, U>

Source§

type Error = Error

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

impl<'d, U: Instance> Write for Uarte<'d, U>

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, T: Instance> Write<u8> for Uarte<'d, T>

Source§

type Error = Error

The type of error that can occur when writing
Source§

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

Writes a slice, blocking until everything has been written Read more
Source§

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

Block until the serial interface has sent all buffered words

Auto Trait Implementations§

§

impl<'d, T> Freeze for Uarte<'d, T>
where T: Freeze,

§

impl<'d, T> RefUnwindSafe for Uarte<'d, T>
where T: RefUnwindSafe,

§

impl<'d, T> Send for Uarte<'d, T>

§

impl<'d, T> Sync for Uarte<'d, T>
where T: Sync,

§

impl<'d, T> Unpin for Uarte<'d, T>
where T: Unpin,

§

impl<'d, T> !UnwindSafe for Uarte<'d, 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

Source§

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

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