Struct DltId

pub struct DltId { /* private fields */ }

A DLT identifier (Application ID or Context ID)

DLT IDs are 1-4 ASCII bytes. Create with DltId::new(b"APP")?. Shorter IDs are internally padded with nulls

Implementations

impl DltId

pub fn new(bytes: &[u8]) -> Result<Self, DltError>

Create a new DLT ID from a byte slice of 1 to 4 bytes

The ID will be validated as ASCII. IDs shorter than 4 bytes are right-padded with null bytes internally.

Errors

Returns DltError::InvalidInput if the byte slice is empty, longer than 4 bytes, or contains non-ASCII characters.

Examples

let id = DltId::new(b"APP")?;
assert_eq!(id.as_str()?, "APP");

// Too long
assert!(DltId::new(b"TOOLONG").is_err());

// Empty
assert!(DltId::new(b"").is_err());

pub fn from_str_clamped(id: &str) -> Result<Self, DltError>

Construct a DltId from a string slice, clamping to 4 bytes

Errors

Returns an error if the string is empty

Example

let id = DltId::from_str_clamped("APPTOOLONG")?;
assert_eq!(id.as_str()?, "APPT");

pub fn as_str(&self) -> Result<&str, DltError>

Get the ID as a string slice

Errors

Returns an error if the bytes are not valid UFT-8. This should never happen due to construction constraints.

Trait Implementations

impl Clone for DltId

fn clone(&self) -> DltId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DltId

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

Formats the value using the given formatter.

impl Hash for DltId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DltId

fn eq(&self, other: &DltId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for DltId

Convert a string slice to a DLT ID, will yield an error if the string is too long or empty

type Error = DltError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for DltId

impl Eq for DltId

impl StructuralPartialEq for DltId