Struct ecu_diagnostics::channel::CanFrame

pub struct CanFrame { /* fields omitted */ }

CAN Frame

Implementations

impl CanFrame

pub fn new(id: u32, data: &[u8], is_ext: bool) -> Self

Creates a new CAN Frame given data and an ID.

Parameters

• id - The CAN ID of the packet
• data - The data of the CAN packet
• is_ext - Indication if the CAN packet shall use extended addressing

NOTE: If [id] is greater than 0x7FF, extended addressing (29bit) will be enabled regardless of [is_ext].

Also, [data] will be limited to 8 bytes.

pub fn is_extended(&self) -> bool

Returns true if the CAN Frame uses Extended (29bit) addressing

Trait Implementations

impl Clone for CanFrame

fn clone(&self) -> CanFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanFrame

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

Formats the value using the given formatter.

impl From<&'_ CanFrame> for PASSTHRU_MSG

fn from(frame: &CanFrame) -> Self

Performs the conversion.

impl From<&'_ PASSTHRU_MSG> for CanFrame

fn from(msg: &PASSTHRU_MSG) -> CanFrame

Performs the conversion.

impl Packet for CanFrame

fn get_address(&self) -> u32

Returns the address of the packet

fn get_data(&self) -> &[u8]

Returns the data of the packet

fn set_address(&mut self, address: u32)

Sets the address of the packet

fn set_data(&mut self, data: &[u8])

Sets the data of the packet

impl PacketChannel<CanFrame> for PassthruCanChannel

fn open(&mut self) -> ChannelResult<()>

Opens the channel, from this point forward, the network filter will be applied to be fully open so data has to be polled rapidly to avoid a driver’s internal buffer from filling up rapidly

fn close(&mut self) -> ChannelResult<()>

Closes the channel. Once closed, no more traffic can be polled or written to the channel.

fn write_packets(
    &mut self,
    packets: Vec<CanFrame>,
    timeout_ms: u32
) -> ChannelResult<()>

Writes a list of packets to the raw interface

fn read_packets(
    &mut self,
    max: usize,
    timeout_ms: u32
) -> ChannelResult<Vec<CanFrame>>

Reads a list of packets from the raw interface

fn clear_rx_buffer(&mut self) -> ChannelResult<()>

Tells the channel to clear its Rx buffer. This means all pending messages to be read should be wiped from the devices queue, such that [BaseChannel::read_bytes] does not read them

fn clear_tx_buffer(&mut self) -> ChannelResult<()>

Tells the channel to clear its Tx buffer. This means all messages that are queued to be sent to the ECU should be wiped.

impl PacketChannel<CanFrame> for SocketCanCanChannel

fn open(&mut self) -> ChannelResult<()>

Opens the channel, from this point forward, the network filter will be applied to be fully open so data has to be polled rapidly to avoid a driver’s internal buffer from filling up rapidly

fn close(&mut self) -> ChannelResult<()>

Closes the channel. Once closed, no more traffic can be polled or written to the channel.

fn write_packets(
    &mut self,
    packets: Vec<CanFrame>,
    timeout_ms: u32
) -> ChannelResult<()>

Writes a list of packets to the raw interface

fn read_packets(
    &mut self,
    max: usize,
    timeout_ms: u32
) -> ChannelResult<Vec<CanFrame>>

Reads a list of packets from the raw interface

fn clear_rx_buffer(&mut self) -> ChannelResult<()>

Tells the channel to clear its Rx buffer. This means all pending messages to be read should be wiped from the devices queue, such that [BaseChannel::read_bytes] does not read them

fn clear_tx_buffer(&mut self) -> ChannelResult<()>

Tells the channel to clear its Tx buffer. This means all messages that are queued to be sent to the ECU should be wiped.

impl Copy for CanFrame