Struct stm32wlxx_hal::subghz::FskBitrate

pub struct FskBitrate { /* private fields */ }

Bitrate argument for FskModParams::set_bitrate and BpskModParams::set_bitrate.

Implementations

impl FskBitrate

pub const fn from_bps(bps: u32) -> Self

Create a new FskBitrate from a bitrate in bits per second.

This the resulting value will be rounded down, and will saturate if bps is outside of the theoretical limits.

Example

use stm32wlxx_hal::subghz::FskBitrate;

const BITRATE: FskBitrate = FskBitrate::from_bps(9600);
assert_eq!(BITRATE.as_bps(), 9600);

pub const fn from_raw(bits: u32) -> Self

Create a new FskBitrate from a raw bit value.

bits = 32 × 32 MHz / bitrate

Note: Only the first 24 bits of the u32 are used, the bits argument will be masked.

Example

use stm32wlxx_hal::subghz::FskBitrate;

const BITRATE: FskBitrate = FskBitrate::from_raw(0x7D00);
assert_eq!(BITRATE.as_bps(), 32_000);

pub const fn as_bps(&self) -> u32

Return the bitrate in bits per second, rounded down.

Example

use stm32wlxx_hal::subghz::FskBitrate;

const BITS_PER_SEC: u32 = 9600;
const BITRATE: FskBitrate = FskBitrate::from_bps(BITS_PER_SEC);
assert_eq!(BITRATE.as_bps(), BITS_PER_SEC);

Trait Implementations

impl Clone for FskBitrate

fn clone(&self) -> FskBitrate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FskBitrate

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

Formats the value using the given formatter.

impl Ord for FskBitrate

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FskBitrate

fn eq(&self, other: &FskBitrate) -> 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 PartialOrd for FskBitrate

fn partial_cmp(&self, other: &Self) -> 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 Copy for FskBitrate

impl Eq for FskBitrate

impl StructuralEq for FskBitrate

impl StructuralPartialEq for FskBitrate