Struct netcdf::variable::Variable

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

This struct defines a netCDF variable.

Implementations

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) -> VariableType

Get the type of this variable

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

pub fn raw_values(
    &self,
    buf: &mut [u8],
    start: &[usize],
    count: &[usize]
) -> Result<()>

Get values of any type as bytes, with no further interpretation of the values.

Note

When working with compound types, variable length arrays and strings will be allocated in buf, and this library will not keep track of the allocations. This can lead to memory leaks.

pub fn vlen<T: Numeric>(&self, index: &[usize]) -> Result<Vec<T>>

Get a vlen element

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.