Enum scpi::tokenizer::Token

pub enum Token<'a> {
    HeaderMnemonicSeparator,
    HeaderCommonPrefix,
    HeaderQuerySuffix,
    ProgramMessageUnitSeparator,
    ProgramHeaderSeparator,
    ProgramDataSeparator,
    ProgramMnemonic(&'a [u8]),
    CharacterProgramData(&'a [u8]),
    DecimalNumericProgramData(&'a [u8]),
    DecimalNumericSuffixProgramData(&'a [u8], &'a [u8]),
    NonDecimalNumericProgramData(u64),
    StringProgramData(&'a [u8]),
    ArbitraryBlockData(&'a [u8]),
    ExpressionProgramData(&'a [u8]),
}

SCPI tokens Loosely based on IEEE488.2 Chapter 7

Variants

HeaderMnemonicSeparator

A header mnemonic separator :

HeaderCommonPrefix

A common header prefix *

HeaderQuerySuffix

A header query suffix ?

ProgramMessageUnitSeparator

A message unit separator ;

ProgramHeaderSeparator

A Program header separator

ProgramDataSeparator

A program data separator ‘,’

ProgramMnemonic(&'a [u8])

A program mnemonic

CharacterProgramData(&'a [u8])

A 7.7.1

DecimalNumericProgramData(&'a [u8])

A 7.7.2

DecimalNumericSuffixProgramData(&'a [u8], &'a [u8])

A 7.7.2 followed by a 7.7.3

NonDecimalNumericProgramData(u64)

A 7.7.4

StringProgramData(&'a [u8])

A 7.7.5

ArbitraryBlockData(&'a [u8])

A 7.7.6

ExpressionProgramData(&'a [u8])

A 7.7.7

Implementations

impl<'a> Token<'a>

pub fn is_data(&self) -> bool

pub fn match_program_header(&self, mnemonic: &'a [u8]) -> bool

Returns true if token is a ProgramMnemonic that matches provided mnemonic. Header suffix is optional if equal to 1 or not present in mnemonic. Header suffixes other than 1 must match exactly.

Eg:

• head[er] == HEADer
• head[er]1 == HEADer
• head[er] == HEADer1
• head[er]<N> == HEADer<N> Where [] marks optional, <> required.

pub fn numeric<F, R: TryFrom<Token<'a>, Error = Error>>(
    self,
    special: F
) -> Result<R, Error> where
    F: FnOnce(NumericValues<'_>) -> Result<R, Error>, 

Handle data as a SCPI and convert to R datatype

**Note: Decimal data is not compared to the maximum/minimum value and must be done seperately (unless equal to max/min of that datatype).

Example

use scpi::tokenizer::Token;
use scpi::NumericValues;
use scpi::error::ErrorCode;
let  s = Token::CharacterProgramData(b"MAXimum");

let mut x = 128u8;
if let Ok(v) = s.numeric(|special| match special {
    NumericValues::Maximum => Ok(255u8),
    NumericValues::Minimum => Ok(0u8),
    NumericValues::Default => Ok(1u8),
    NumericValues::Up => Ok(x+1),
    NumericValues::Down => Ok(x-1),
    _ => Err(ErrorCode::ParameterError.into())
}) {
    //v is resolved to a u8 type
    x = v;
}

pub fn numeric_range<F, R: TryFrom<Token<'a>, Error = Error>>(
    &self,
    min: R,
    max: R,
    special: F
) -> Result<R, Error> where
    F: FnOnce(NumericValues<'_>) -> Result<R, Error>,
    R: PartialOrd + Copy, 

Trait Implementations

impl<'a> Clone for Token<'a>

fn clone(&self) -> Token<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Token<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Token<'a>> for Token<'a>

fn eq(&self, other: &Token<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Token<'a>) -> bool

This method tests for !=.

impl<'a, UNIT> TryFrom<Token<'a>> for Amplitude<UNIT> where
    UNIT: TryFrom<Token<'a>, Error = Error>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Length<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    meter: Conversion<V>,
    kilometer: Conversion<V>,
    meter: Conversion<V>,
    millimeter: Conversion<V>,
    micrometer: Conversion<V>,
    nanometer: Conversion<V>,
    nautical_mile: Conversion<V>,
    mile: Conversion<V>,
    foot: Conversion<V>,
    inch: Conversion<V>,
    mil: Conversion<V>,
    parsec: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for ElectricCharge<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    coulomb: Conversion<V>,
    megacoulomb: Conversion<V>,
    kilocoulomb: Conversion<V>,
    coulomb: Conversion<V>,
    millicoulomb: Conversion<V>,
    microcoulomb: Conversion<V>,
    ampere_hour: Conversion<V>,
    milliampere_hour: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Capacitance<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    farad: Conversion<V>,
    farad: Conversion<V>,
    millifarad: Conversion<V>,
    microfarad: Conversion<V>,
    nanofarad: Conversion<V>,
    picofarad: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Inductance<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    henry: Conversion<V>,
    henry: Conversion<V>,
    millihenry: Conversion<V>,
    microhenry: Conversion<V>,
    nanohenry: Conversion<V>,
    picohenry: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Energy<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    joule: Conversion<V>,
    megajoule: Conversion<V>,
    kilojoule: Conversion<V>,
    joule: Conversion<V>,
    megajoule: Conversion<V>,
    microjoule: Conversion<V>,
    megawatt_hour: Conversion<V>,
    watt_hour: Conversion<V>,
    milliwatt_hour: Conversion<V>,
    electronvolt: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Power<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    watt: Conversion<V>,
    megawatt: Conversion<V>,
    kilowatt: Conversion<V>,
    watt: Conversion<V>,
    milliwatt: Conversion<V>,
    microwatt: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Db<V, Power<U, V>> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    Power<U, V>: TryFrom<Token<'a>, Error = Error>,
    watt: Conversion<V>,
    milliwatt: Conversion<V>,
    microwatt: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Angle<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    radian: Conversion<V>,
    radian: Conversion<V>,
    degree: Conversion<V>,
    aminute: Conversion<V>,
    revolution: Conversion<V>,
    gon: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for AmountOfSubstance<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    mole: Conversion<V>,
    mole: Conversion<V>,
    millimole: Conversion<V>,
    micromole: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for MagneticFlux<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    weber: Conversion<V>,
    weber: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for MagneticFluxDensity<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    tesla: Conversion<V>,
    tesla: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Velocity<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    meter_per_second: Conversion<V>,
    kilometer_per_second: Conversion<V>,
    kilometer_per_hour: Conversion<V>,
    meter_per_second: Conversion<V>,
    millimeter_per_second: Conversion<V>,
    micrometer_per_second: Conversion<V>,
    mile_per_second: Conversion<V>,
    mile_per_hour: Conversion<V>,
    foot_per_second: Conversion<V>,
    inch_per_second: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Ratio<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    ratio: Conversion<V>,
    percent: Conversion<V>,
    part_per_million: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Db<V, Ratio<U, V>> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    Ratio<U, V>: TryFrom<Token<'a>, Error = Error>,
    ratio: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Time<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    second: Conversion<V>,
    second: Conversion<V>,
    millisecond: Conversion<V>,
    microsecond: Conversion<V>,
    nanosecond: Conversion<V>,
    minute: Conversion<V>,
    hour: Conversion<V>,
    day: Conversion<V>,
    year: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Pressure<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    atmosphere: Conversion<V>,
    atmosphere: Conversion<V>,
    millimeter_of_mercury: Conversion<V>,
    inch_of_mercury: Conversion<V>,
    torr: Conversion<V>,
    millitorr: Conversion<V>,
    pascal: Conversion<V>,
    kilopascal: Conversion<V>,
    bar: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Volume<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    liter: Conversion<V>,
    liter: Conversion<V>,
    milliliter: Conversion<V>,
    cubic_meter: Conversion<V>,
    cubic_millimeter: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for &'a [u8]

Convert string data data into a slice (&[u8]).

Returns

• Ok(&[u8]) - If data is a string.
• Err(DataTypeError) - If data is not a string.
• Err(SyntaxError) - If token is not data

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<&'a [u8], Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for bool

Convert string data data into a boolean.

Returns

• Ok(bool) - If data is character data matching ON|OFF or numeric 1|0.
• Err(IllegalParameterValue) - If data is character data or numeric but is not a boolean
• Err(DataTypeError) - If data is not a character data or numeric.
• Err(SyntaxError) - If token is not data.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<bool, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for &'a str

Convert string/block data data into a str.

Returns

• Ok(&str) - If data is a string or block data.
• Err(DataTypeError) - If data is not a string.
• Err(StringDataError) - If string is not valid utf8
• Err(SyntaxError) - If token is not data

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<&'a str, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for Arbitrary<'a>

Convert character data into a str.

Returns

• Ok(&str) - If data is character data.
• Err(DataTypeError) - If data is not character string.
• Err(SyntaxError) - If token is not data

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Arbitrary<'a>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for Character<'a>

Convert character data into a str.

Returns

• Ok(&str) - If data is character data.
• Err(DataTypeError) - If data is not character string.
• Err(SyntaxError) - If token is not data

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Character<'a>, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Acceleration<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    meter_per_second_squared: Conversion<V>,
    kilometer_per_second_squared: Conversion<V>,
    meter_per_second_squared: Conversion<V>,
    millimeter_per_second_squared: Conversion<V>,
    micrometer_per_second_squared: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for NumericList<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<NumericList<'a>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for ChannelList<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<ChannelList<'a>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for Expression<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Expression<'a>, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for f32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for f64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for usize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for isize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for ElectricPotential<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    volt: Conversion<V>,
    kilovolt: Conversion<V>,
    volt: Conversion<V>,
    millivolt: Conversion<V>,
    microvolt: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for u32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for i16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for u16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for i8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Token<'a>> for u8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Db<V, ElectricPotential<U, V>> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    ElectricPotential<U, V>: TryFrom<Token<'a>, Error = Error>,
    volt: Conversion<V>,
    millivolt: Conversion<V>,
    microvolt: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for ElectricCurrent<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    ampere: Conversion<V>,
    kiloampere: Conversion<V>,
    ampere: Conversion<V>,
    milliampere: Conversion<V>,
    microampere: Conversion<V>,
    nanoampere: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for Db<V, ElectricCurrent<U, V>> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    ElectricCurrent<U, V>: TryFrom<Token<'a>, Error = Error>,
    ampere: Conversion<V>,
    milliampere: Conversion<V>,
    microampere: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for ElectricalConductance<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    siemens: Conversion<V>,
    kilosiemens: Conversion<V>,
    siemens: Conversion<V>,
    millisiemens: Conversion<V>,
    microsiemens: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, U, V> TryFrom<Token<'a>> for ElectricalResistance<U, V> where
    U: Units<V> + ?Sized,
    V: Num + Conversion<V> + TryFrom<Token<'a>, Error = Error>,
    ohm: Conversion<V>,
    gigaohm: Conversion<V>,
    megaohm: Conversion<V>,
    kiloohm: Conversion<V>,
    ohm: Conversion<V>,
    microohm: Conversion<V>, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Token<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for Token<'a>

impl<'a> StructuralPartialEq for Token<'a>