ace-core 0.1.0

Foundation layer, providing three codec traits that the rest of ACE builds on: FrameRead, FrameWrite, Writer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

#![no_std]

#[cfg(feature = "alloc")]
extern crate alloc;

pub mod codec;
pub use codec::{take_n, FrameCodec, FrameRead, FrameWrite, Writer};

pub mod iter;
pub use iter::FrameIter;

// region: Addressing

pub trait DiagnosticAddress: Clone + core::fmt::Debug {
    fn address_mode(&self) -> AddressMode;
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum AddressMode {
    Physical,
    Functional,
}

// endregion: Addressing

// region: Errors

#[derive(Debug)]
pub enum DiagError {
    Timeout,
    InvalidFrame(heapless::String<64>),
    BufferOverflow,
    Driver(heapless::String<64>),
    AddressNotReachable,
    LengthMismatch { expected: usize, actual: usize },
}

pub fn diag_err_str(s: &str) -> heapless::String<64> {
    let mut hs = heapless::String::new();
    let _ = hs.push_str(s);
    hs
}

// endregion: Errors