Struct netcdf::GroupMut

pub struct GroupMut<'f>(/* private fields */);

Mutable access to a group.

This type derefs to a Group, which means GroupMut can be used where Group is expected

Implementations

impl<'f> GroupMut<'f>

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

where 'f: 'g,

Get a mutable variable from the group

pub fn variables_mut<'g>(&'g mut self) -> impl Iterator<Item = VariableMut<'g>>

where 'f: 'g,

Iterate over all variables in a group, with mutable access

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

where 'f: 'g,

Mutable access to subgroup

pub fn groups_mut<'g>(&'g mut self) -> impl Iterator<Item = GroupMut<'g>>

where 'f: 'g,

Iterator over all groups (mutable access)

pub fn add_opaque_type( &'f mut self, name: &str, size: usize ) -> Result<OpaqueType>

Add an opaque datatype, with size bytes

pub fn add_vlen_type<T: NcPutGet>(&'f mut self, name: &str) -> Result<VlenType>

Add a variable length datatype

pub fn add_enum_type<T: NcPutGet>( &'f mut self, name: &str, mappings: &[(&str, T)] ) -> Result<EnumType>

Add an enum datatype

pub fn add_compound_type(&mut self, name: &str) -> Result<CompoundBuilder>

Build a compound type

pub fn add_attribute<'a, T>( &'a mut self, name: &str, val: T ) -> Result<Attribute<'a>>

where T: Into<AttributeValue>,

Add an attribute to the group

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

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

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

Adds a dimension with unbounded size

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

where 'f: 'g,

Add an empty group to the dataset

pub fn add_variable<'g, T>( &'g mut self, name: &str, dims: &[&str] ) -> Result<VariableMut<'g>>

where T: NcPutGet, 'f: 'g,

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<'g>( &mut self, name: &str, dims: &[&str] ) -> Result<VariableMut<'g>>

Adds a variable with a basic type of string

pub fn add_variable_from_identifiers<'g, T>( &'g mut self, name: &str, dims: &[DimensionIdentifier] ) -> Result<VariableMut<'g>>

where T: NcPutGet,

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

pub fn add_variable_with_type( &'f mut self, name: &str, dims: &[&str], typ: &VariableType ) -> Result<VariableMut<'f>>

Create a variable with the specified type

Methods from Deref<Target = Group<'f>>

pub fn name(&self) -> String

Name of the current group

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

where 'f: 'g,

Get a variable from the group

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

where 'f: 'g,

Iterate over all variables in a group

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

Get a single attribute

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

Get all attributes in the group

pub fn attribute_value(&self, name: &str) -> Option<Result<AttributeValue>>

Get the attribute value

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

where 'f: 'g,

Get a single dimension

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

where 'f: 'g,

Iterator over all dimensions

pub fn group<'g>(&'g self, name: &str) -> Option<Group<'g>>

where 'f: 'g,

Get a group

pub fn groups<'g>(&'g self) -> impl Iterator<Item = Group<'g>>

where 'f: 'g,

Iterator over all subgroups in this group

pub fn types(&self) -> impl Iterator<Item = VariableType>

Return all types in this group

Trait Implementations

impl<'f> Debug for GroupMut<'f>

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

Formats the value using the given formatter.

impl<'f> Deref for GroupMut<'f>

type Target = Group<'f>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.