embassy-stm32

Crates

git

Versions

stm32f412zg

Flavors

embassy_stm32::can

Struct BufferedCan

Source
pub struct BufferedCan<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> { /* private fields */ }
Expand description

Buffered CAN driver.

Implementations§

Source§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

Source

pub async fn write(&mut self, frame: &Frame)

Async write frame to TX buffer.

Source

pub fn writer(&self) -> BufferedCanSender

Returns a sender that can be used for sending CAN frames.

Source

pub async fn read(&mut self) -> Result<Envelope, BusError>

Async read frame from RX buffer.

Source

pub fn try_read(&mut self) -> Result<Envelope, TryReadError>

Attempts to read a CAN frame without blocking.

Returns [Err(TryReadError::Empty)] if there are no frames in the rx queue.

Source

pub async fn wait_not_empty(&mut self)

Waits while receive queue is empty.

Source

pub fn reader(&self) -> BufferedCanReceiver

Returns a receiver that can be used for receiving CAN frames. Note, each CAN frame will only be received by one receiver.

Auto Trait Implementations§

§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> Freeze for BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> !RefUnwindSafe for BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> !Send for BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> !Sync for BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> Unpin for BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

§

impl<'d, const TX_BUF_SIZE: usize, const RX_BUF_SIZE: usize> !UnwindSafe for BufferedCan<'d, TX_BUF_SIZE, RX_BUF_SIZE>

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.