Enum Pmt 

#[non_exhaustive]
pub enum Pmt {
    Ok,
    InvalidValue,
    Null,
    String(String),
    Bool(bool),
    Usize(usize),
    Isize(isize),
    U32(u32),
    U64(u64),
    F32(f32),
    F64(f64),
    VecCF32(Vec<Complex<f32>>),
    VecF32(Vec<f32>),
    VecU64(Vec<u64>),
    Blob(Vec<u8>),
    VecPmt(Vec<Pmt>),
    Finished,
    MapStrPmt(HashMap<String, Pmt>),
    Any(Box<dyn PmtAny>),
}

Polymorphic message type used by FutureSDR message ports.

PMTs are the input and output values for message handlers and runtime control calls. Most variants serialize normally; Pmt::Any is skipped during serialization and is intended only for in-process values.

String parsing accepts a few short forms such as Ok, Null, true, and false, plus serde-compatible enum JSON such as { "U32": 123 } and the compact U32: 123 syntax used by simple UIs.

use futuresdr_types::{Pmt, PmtKind};

let pmt = Pmt::Usize(7);
assert_eq!(pmt.kind(), PmtKind::Usize);
assert_eq!(usize::try_from(pmt)?, 7);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ok

Successful operation without additional payload.

InvalidValue

Invalid value.

Mainly used as the return type in message handlers when the parameter is outside the allowed range.

Null

Absence of a value.

Used, for example, as the input type, when the message handler is mainly about the return type.

String(String)

UTF-8 string.

Bool(bool)

Boolean.

Usize(usize)

Native-sized unsigned integer.

Isize(isize)

Native-sized signed integer.

U32(u32)

32-bit unsigned integer.

U64(u64)

64-bit unsigned integer.

F32(f32)

32-bit float.

F64(f64)

64-bit float.

VecCF32(Vec<Complex<f32>>)

Vector of 32-bit complex floats.

VecF32(Vec<f32>)

Vector of 32-bit floats.

VecU64(Vec<u64>)

Vector of 64-bit unsigned integers.

Blob(Vec<u8>)

Binary data blob.

VecPmt(Vec<Pmt>)

Vector of PMT values.

Finished

Runtime message used to signal that a connected block finished.

MapStrPmt(HashMap<String, Pmt>)

Map from string keys to PMT values.

Any(Box<dyn PmtAny>)

Type-erased in-process payload.

Wrap anything that implements Any in a Pmt. Use downcast_ref/mut() to extract.

Implementations

impl Pmt

pub fn kind(&self) -> PmtKind

Get the PMT variant kind without associated data.

impl Pmt

pub fn from_string(s: &str, t: &PmtKind) -> Option<Pmt>

Create a Pmt by parsing a string into a specific PmtKind.

Only scalar kinds that have a straightforward textual representation are supported here. Use std::str::FromStr for full PMT JSON parsing.

Trait Implementations

impl Clone for Pmt

fn clone(&self) -> Pmt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pmt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Pmt

fn deserialize<__D>( __deserializer: __D, ) -> Result<Pmt, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pmt

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

Formats the value using the given formatter.

impl From<&Pmt> for PmtKind

fn from(value: &Pmt) -> PmtKind

Converts to this type from the input type.

impl From<()> for Pmt

fn from(_: ()) -> Pmt

Converts to this type from the input type.

impl From<Pmt> for PmtKind

fn from(value: Pmt) -> PmtKind

Converts to this type from the input type.

impl From<Vec<Complex<f32>>> for Pmt

fn from(v: Vec<Complex<f32>>) -> Pmt

Converts to this type from the input type.

impl From<Vec<f32>> for Pmt

fn from(v: Vec<f32>) -> Pmt

Converts to this type from the input type.

impl From<Vec<u64>> for Pmt

fn from(v: Vec<u64>) -> Pmt

Converts to this type from the input type.

impl From<bool> for Pmt

fn from(b: bool) -> Pmt

Converts to this type from the input type.

impl From<f32> for Pmt

fn from(f: f32) -> Pmt

Converts to this type from the input type.

impl From<f64> for Pmt

fn from(f: f64) -> Pmt

Converts to this type from the input type.

impl From<isize> for Pmt

fn from(f: isize) -> Pmt

Converts to this type from the input type.

impl From<u32> for Pmt

fn from(f: u32) -> Pmt

Converts to this type from the input type.

impl From<u64> for Pmt

fn from(f: u64) -> Pmt

Converts to this type from the input type.

impl From<usize> for Pmt

fn from(f: usize) -> Pmt

Converts to this type from the input type.

impl FromStr for Pmt

type Err = PmtConversionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Pmt, <Pmt as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Pmt

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Pmt

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Pmt> for Vec<Complex<f32>>

type Error = PmtConversionError

The type returned in the event of a conversion error.

fn try_from( value: Pmt, ) -> Result<Vec<Complex<f32>>, <Vec<Complex<f32>> as TryFrom<Pmt>>::Error>

Performs the conversion.

impl TryFrom<Pmt> for Vec<f32>

type Error = PmtConversionError

The type returned in the event of a conversion error.

fn try_from(value: Pmt) -> Result<Vec<f32>, <Vec<f32> as TryFrom<Pmt>>::Error>

Performs the conversion.

impl TryFrom<Pmt> for Vec<u64>

type Error = PmtConversionError

The type returned in the event of a conversion error.

fn try_from(value: Pmt) -> Result<Vec<u64>, <Vec<u64> as TryFrom<Pmt>>::Error>

Performs the conversion.