Skip to main content

OfdmProbeFrame

Struct OfdmProbeFrame 

Source
pub struct OfdmProbeFrame {
    pub sequence_num: Option<u32>,
    pub constellation: ConstellationOrder,
    pub codeword_bits: usize,
    pub codeword_info_bits: usize,
    pub decoded: bool,
    /* private fields */
}
Expand description

One frame’s probe record: where its symbols and correction map live inside the owning OfdmRxProbe’s flat buffers, plus the metadata needed to render them.

Fields§

§sequence_num: Option<u32>

The frame’s sequence number, or None when the link carries no header-derived one. Always Some on the header-bearing COFDM path this receiver decodes — a frame whose header fails never reaches the payload demapper and so produces no probe record at all.

§constellation: ConstellationOrder

The payload constellation the symbols were demapped against, so a display can draw the right reference points without re-reading the MCS table.

§codeword_bits: usize

The inner code’s codeword length n, so a display can draw codeword boundaries across the map. 0 when the inner code has no block structure to draw — InnerFec::None and the convolutional arm, which terminates once per frame rather than per codeword.

§codeword_info_bits: usize

The inner code’s information length k, on the same terms as codeword_bits. For a systematic code the first k bits of each codeword are the message.

§decoded: bool

Whether the payload decoded and passed its integrity check. false ⇒ there is no ground truth, so ProbedFrame::correction is empty and only the symbols are meaningful.

The map therefore empties exactly when the link is worst. That is honest — nothing can be measured against a payload that did not verify — but it has to be rendered as “no ground truth”, not as “no errors”.

Trait Implementations§

Source§

impl Clone for OfdmProbeFrame

Source§

fn clone(&self) -> OfdmProbeFrame

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 Debug for OfdmProbeFrame

Source§

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

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

impl Eq for OfdmProbeFrame

Source§

impl PartialEq for OfdmProbeFrame

Source§

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

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.