Struct arduino_hal::usart::Baudrate

pub struct Baudrate<CLOCK> {
    pub ubrr: u16,
    pub u2x: bool,
    pub _clock: PhantomData<CLOCK>,
}

Representation of a USART baudrate

Precalculated parameters for configuring a certain USART baudrate.

Fields

ubrr: u16

Value of the UBRR# register

u2x: bool

Value of the U2X# bit

_clock: PhantomData<CLOCK>

The baudrate calculation depends on the configured clock rate, thus a CLOCK generic parameter is needed.

Implementations

impl<CLOCK> Baudrate<CLOCK>

where CLOCK: Clock,

pub fn new(baud: u32) -> Baudrate<CLOCK>

Calculate parameters for a certain baudrate at a certain CLOCK speed.

pub fn with_exact(u2x: bool, ubrr: u16) -> Baudrate<CLOCK>

Construct a Baudrate from given UBRR# and U2X# values.

This provides exact control over the resulting clock speed.

Trait Implementations

impl<CLOCK> Clone for Baudrate<CLOCK>

where CLOCK: Clone,

fn clone(&self) -> Baudrate<CLOCK>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CLOCK> Debug for Baudrate<CLOCK>

where CLOCK: Debug,

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

Formats the value using the given formatter.

impl<CLOCK> From<u32> for Baudrate<CLOCK>

where CLOCK: Clock,

fn from(baud: u32) -> Baudrate<CLOCK>

Converts to this type from the input type.

impl<CLOCK> Ord for Baudrate<CLOCK>

where CLOCK: Clock,

fn cmp(&self, other: &Baudrate<CLOCK>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<CLOCK> PartialEq for Baudrate<CLOCK>

where CLOCK: Clock,

fn eq(&self, other: &Baudrate<CLOCK>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<CLOCK> PartialOrd for Baudrate<CLOCK>

where CLOCK: Clock,

fn partial_cmp(&self, other: &Baudrate<CLOCK>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<CLOCK> Copy for Baudrate<CLOCK>

where CLOCK: Copy,

impl<CLOCK> Eq for Baudrate<CLOCK>

where CLOCK: Clock,