Struct netcdf::group::Group

pub struct Group { /* fields omitted */ }

Main component of the netcdf format. Holds all variables, attributes, and dimensions. A group can always see the parents items, but a parent can not access a childs items.

Methods

impl Group

pub fn name(&self) -> &str

Name of the current group

pub fn variable(&self, name: &str) -> Option<&Variable>

Get a variable from the group

pub fn variables(&self) -> impl Iterator<Item = &Variable>

Iterate over all variables in a group

pub fn variable_mut(&mut self, name: &str) -> Option<&mut Variable>

Get a mutable variable from the group

pub fn variables_mut(&mut self) -> impl Iterator<Item = &mut Variable>

Iterate over all variables in a group, with mutable access

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

Get a single attribute

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

Get all attributes

pub fn dimension(&self, name: &str) -> Option<&Dimension>

Get a single dimension

pub fn dimensions(&self) -> impl Iterator<Item = &Dimension>

Iterator over all dimensions

pub fn group(&self, name: &str) -> Option<&Self>

Get a group

pub fn groups(&self) -> impl Iterator<Item = &Self>

Iterator over all groups

pub fn group_mut(&mut self, name: &str) -> Option<&mut Self>

Mutable access to group

pub fn groups_mut(&mut self) -> impl Iterator<Item = &mut Self>

Iterator over all groups (mutable access)

impl Group

pub fn add_attribute<T>(&mut self, name: &str, val: T) -> Result<()> where
    T: Into<AttrValue>, 

Add an attribute to the group

pub fn add_dimension(
    &mut self,
    name: &str,
    len: usize
) -> Result<&mut Dimension>

Adds a dimension with the given name and size. A size of zero gives an unlimited dimension

pub fn add_unlimited_dimension(&mut self, name: &str) -> Result<&mut Dimension>

Adds a dimension with unbounded size

pub fn add_group(&mut self, name: &str) -> Result<&mut Self>

Add an empty group to the dataset

pub fn add_variable_from_identifiers<T>(
    &mut self,
    name: &str,
    dims: &[Identifier]
) -> Result<&mut Variable> where
    T: Numeric, 

Adds a variable from a set of unique identifiers, recursing upwards from the current group if necessary.

pub fn add_variable<T>(
    &mut self,
    name: &str,
    dims: &[&str]
) -> Result<&mut Variable> where
    T: Numeric, 

Create a Variable into the dataset, with no data written into it

Dimensions are identified using the name of the dimension, and will recurse upwards if not found in the current group.

pub fn add_string_variable(
    &mut self,
    name: &str,
    dims: &[&str]
) -> Result<&mut Variable>

Adds a variable with a basic type of string

Trait Implementations

impl Debug for Group

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

Formats the value using the given formatter.