Skip to main content

DutyCycle

Struct DutyCycle 

Source
#[non_exhaustive]
pub struct DutyCycle { pub available: bool, pub next_available_in_ms: u64, }
Expand description

Why a medium is not transmitting, when the answer is “not yet”.

The case #49 calls sharpest, and the reason it is in v1 rather than deferred with the rest: a compliant EU868 backend must block in send for up to ~99 s, and an operator watching queue_depth climb cannot tell “duty-cycle limited” from “radio dead”. SimMedium::slide_to_contact already blocks for exactly this reason and ContactWindow::wait_at already computes the number, so this is a producer that exists rather than a keyspace row waiting for hardware.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§available: bool

Whether the medium would take an SDU right now.

§next_available_in_ms: u64

Milliseconds until it would, when it would not.

Zero while available is false means the medium is blocked and does not know for how long, which is a different answer from “blocked for 0 ms” and a real state for a device that can say it is busy without saying when it will not be.

Implementations§

Source§

impl DutyCycle

Source

pub fn ready() -> Self

The medium would take an SDU now.

Source

pub fn wait_ms(ms: u64) -> Self

The medium would not, and this is how long until it would.

Two named constructors rather than one taking (bool, u64), because the two states are what a caller is choosing between and a boolean argument at a call site says nothing about which way round it goes.

Trait Implementations§

Source§

impl Clone for DutyCycle

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DutyCycle

Source§

impl Debug for DutyCycle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DutyCycle

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for DutyCycle

Source§

impl PartialEq for DutyCycle

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DutyCycle

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.