Struct Chan 

pub struct Chan(/* private fields */);

Implementations

impl Chan

For channels known at compile time Validation happens at compile time via const fn

pub fn new<P: ChanValidate>(id: u8) -> Result<Self, P::Error>

Creates a new Chan with platform-specific validation via P.

pub unsafe fn new_unchecked(id: u8) -> Self

Safety

This constructor does not perform any validation on the provided id. It is the caller’s responsibility to ensure that the id is valid for the intended platform and use case.

In driver implementations, the implementor should refer to the platform-specific documentation for the valid range of channel IDs. Hence, this function is unsafe and should be used with caution.

In real implementation, it should be like:

use consortium_core::Chan;

// Here we assume a `Channel` for `stm32mp2` series.

impl ChanValidate for stm32mp::Channel {
   type Error = &'static str;

   fn validate(id: u8) -> Result<Chan, Self::Error> {
       if id < 16 {
           Ok(unsafe { Chan::new_unchecked(id) })
       } else {
           Err("Invalid channel ID")
       }
   }
}

pub fn id(&self) -> u8

Returns the raw channel identifier.

Trait Implementations

impl Clone for Chan

fn clone(&self) -> Chan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Chan

impl Debug for Chan

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

Formats the value using the given formatter.

impl Eq for Chan

impl From<Chan> for u8

fn from(chan: Chan) -> Self

Converts to this type from the input type.

impl PartialEq for Chan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Chan