Struct Field 

#[non_exhaustive]
pub struct Field<'a> {
    pub message: usize,
    pub discipline: u8,
    pub center: u16,
    pub reference_time: ReferenceTime,
    pub grid: Grid,
    pub product: Product,
    pub packing: Packing,
    /* private fields */
}

One field of a GRIB2 file: its headers, with its bitmap and packed values borrowed from the file’s bytes.

It holds no serde derive, since it borrows; its parts (Grid, Product and the others) do.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: usize

The message it is in, from 0.

discipline: u8

The discipline (code table 0.0): 0 meteorological products.

center: u16

The originating center (common code table C-11): 7 is NCEP.

reference_time: ReferenceTime

The reference time.

grid: Grid

The grid.

product: Product

What the field is.

packing: Packing

How it is packed.

Implementations

impl Field<'_>

pub fn points(&self) -> u64

The grid’s points, ni · nj.

pub fn value(&self, index: u64) -> Result<Option<f64>, Grib2Error>

The value at grid point index (numbered as on Grid), or None where the field has none there. A complex-packed field’s values can only be read in order, so this reads it from its start up to the point, and a JPEG 2000 field’s image is decoded whole: for more than a few points, use Field::values_at or Field::values, which read it once.

Errors

Grib2Error::PointOutside when index is not below Field::points, and Grib2Error::Malformed when a complex-packed field’s differences overflow or a JPEG 2000 codestream does not decode to the field’s values.

pub fn values_at(&self, indices: &[u64]) -> Result<Vec<Option<f64>>, Grib2Error>

The values at several grid points, in the order asked, reading a complex-packed field once up to the last of them.

Errors

As Field::value.

pub fn values(&self) -> Result<Vec<Option<f64>>, Grib2Error>

Every grid point’s value, in grid order; None where the field has none. It allocates 16 bytes a point, up to 256 MiB at MAX_POINTS, even for a field of 0 bits in a tiny file; decoding a JPEG 2000 image takes more while it runs.

Errors

Grib2Error::Malformed when a complex-packed field’s differences overflow or a JPEG 2000 codestream does not decode to the field’s values.

Trait Implementations

impl<'a> Clone for Field<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Field<'a>

fn eq(&self, other: &Field<'a>) -> 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<'a> StructuralPartialEq for Field<'a>