Struct netcdf::variable::Variable

pub struct Variable<'g> { /* fields omitted */ }

This struct defines a netCDF variable.

Methods

impl<'g> Variable<'g>

pub fn name(&self) -> String

Get name of variable

pub fn attribute<'a>(&'a self, name: &str) -> Option<Attribute<'a>>

Get an attribute of this variable

pub fn attributes(&self) -> impl Iterator<Item = Attribute>

Iterator over all the attributes of this variable

pub fn dimensions(&self) -> &[Dimension]

Dimensions for a variable

pub fn vartype(&self) -> nc_type

Get the type of this variable. This will be an integer such as NC_FLOAT, NC_DOUBLE, NC_INT from the netcdf-sys crate

pub fn len(&self) -> usize

Get current length of the variable

pub fn endian_value(&self) -> Result<Endianness>

Get endianness of the variable.

Errors

Not a netCDF-4 file

impl<'g> Variable<'g>

pub fn value<T: Numeric>(&self, indices: Option<&[usize]>) -> Result<T>

Fetches one specific value at specific indices indices must has the same length as self.dimensions.

pub fn string_value(&self, indices: Option<&[usize]>) -> Result<String>

Reads a string variable. This involves two copies per read, and should be avoided in performance critical code

pub fn values<T: Numeric>(
    &self,
    indices: Option<&[usize]>,
    slice_len: Option<&[usize]>
) -> Result<ArrayD<T>>

Fetches variable

pub fn fill_value<T: Numeric>(&self) -> Result<Option<T>>

Get the fill value of a variable

pub fn values_to<T: Numeric>(
    &self,
    buffer: &mut [T],
    indices: Option<&[usize]>,
    slice_len: Option<&[usize]>
) -> Result<()>

Fetches variable into slice buffer must be able to hold all the requested elements

pub fn values_strided_to<T: Numeric>(
    &self,
    buffer: &mut [T],
    indices: Option<&[usize]>,
    slice_len: Option<&[usize]>,
    strides: &[isize]
) -> Result<usize>

Fetches variable into slice buffer must be able to hold all the requested elements

Trait Implementations

impl<'g> Clone for Variable<'g>

fn clone(&self) -> Variable<'g>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for Variable<'g>

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

Formats the value using the given formatter.