Struct grib::Parameter

pub struct Parameter {
    pub discipline: u8,
    pub centre: u16,
    pub master_ver: u8,
    pub local_ver: u8,
    pub category: u8,
    pub num: u8,
}

Parameter of the product.

In the context of GRIB products, parameters refer to weather elements such as air temperature, air pressure, and humidity, and other physical quantities.

With is_identical_to, users can check if the parameter is identical to a third-party code, such as NCEP.

Fields

discipline: u8

Discipline of processed data in the GRIB message.

centre: u16

GRIB master tables version number.

master_ver: u8

Parameter category by product discipline.

local_ver: u8

GRIB local tables version number.

category: u8

Identification of originating/generating centre.

num: u8

Parameter number by product discipline and parameter category.

Implementations

impl Parameter

pub fn description(&self) -> Option<String>

Looks up the parameter’s WMO description.

Examples

// Extracted from the first submessage of JMA MSM GRIB2 data.
let param = grib::Parameter {
    discipline: 0,
    centre: 34,
    master_ver: 2,
    local_ver: 1,
    category: 3,
    num: 5,
};
assert_eq!(param.description(), Some("Geopotential height".to_owned()))

pub fn is_identical_to<'a, T>(&'a self, code: T) -> bool

where T: TryFrom<&'a Self> + PartialEq,

Checks if the parameter is identical to a third-party code, such as NCEP.

Examples

use grib::codetables::NCEP;

// Extracted from the first submessage of JMA MSM GRIB2 data.
let param = grib::Parameter {
    discipline: 0,
    centre: 34,
    master_ver: 2,
    local_ver: 1,
    category: 3,
    num: 5,
};
assert!(param.is_identical_to(NCEP::HGT));

Trait Implementations

impl Debug for Parameter

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

Formats the value using the given formatter.

impl PartialEq for Parameter

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

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

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

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

impl TryFrom<&Parameter> for NCEP

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &Parameter) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Parameter

impl StructuralPartialEq for Parameter