Skip to main content

ProtocolMeta

mfsk_core::registry

Struct ProtocolMeta 

Source 
pub struct ProtocolMeta {
Show 16 fields
    pub id: ProtocolId,
    pub name: &'static str,
    pub ntones: u32,
    pub bits_per_symbol: u32,
    pub nsps: u32,
    pub symbol_dt: f32,
    pub tone_spacing_hz: f32,
    pub gfsk_bt: f32,
    pub gfsk_hmod: f32,
    pub n_data: u32,
    pub n_sync: u32,
    pub n_symbols: u32,
    pub t_slot_s: f32,
    pub fec_k: usize,
    pub fec_n: usize,
    pub payload_bits: u32,

}
Expand description

Compile-time metadata describing one wired protocol.

Every field is sourced from the trait surface — see the protocol_meta! macro in this module’s source for the explicit mapping. Field order matches a typical “what does this protocol look like” display: identity → modulation → frame → FEC → payload.

Fields§

§id: ProtocolId

Family-level protocol id used at the FFI boundary. Multiple ProtocolMeta entries may share an id (e.g. all six Q65 sub-modes are ProtocolId::Q65).

§name: &'static str

Human-readable name (e.g. "FT8", "Q65-60D"). Stable — safe for logs, UI strings, and as a by_name key.

§ntones: u32

Number of FSK tones (ModulationParams::NTONES).

§bits_per_symbol: u32

Information bits per modulated symbol.

§nsps: u32

Samples per symbol at 12 kHz.

§symbol_dt: f32

Symbol duration in seconds.

§tone_spacing_hz: f32

Tone-to-tone spacing in Hz.

§gfsk_bt: f32

Gaussian bandwidth-time product (0 = plain FSK).

§gfsk_hmod: f32

FSK modulation index (h).

§n_data: u32

Data symbols per frame.

§n_sync: u32

Sync symbols per frame (interleaved-sync protocols report 0).

§n_symbols: u32

Total channel symbols per frame (= n_data + n_sync).

§t_slot_s: f32

Nominal slot length in seconds (15 / 7.5 / 30 / 60 / 120).

§fec_k: usize

FEC info-bit budget — FecCodec::K.

§fec_n: usize

FEC codeword length in bits — FecCodec::N.

§payload_bits: u32

Message-codec payload width — MessageCodec::PAYLOAD_BITS.

Trait Implementations§

Source§

impl Clone for ProtocolMeta

Source§

fn clone(&self) -> ProtocolMeta

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProtocolMeta

Source§

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

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

impl Copy for ProtocolMeta

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.