Skip to main content

Nc4File

Struct Nc4File 

Source
pub struct Nc4File {
    pub root: Nc4Group,
    pub global_attributes: Vec<(String, String)>,
    pub dimensions: Vec<(String, Option<usize>)>,
    pub unlimited_size: usize,
}
Expand description

A NetCDF-4 (HDF5-based) in-memory dataset with group support.

Fields§

§root: Nc4Group

Root group (equivalent to “/” in HDF5).

§global_attributes: Vec<(String, String)>

Global (file-level) attributes.

§dimensions: Vec<(String, Option<usize>)>

All dimensions (name → size, None = unlimited).

§unlimited_size: usize

Current size of the unlimited dimension (number of records written).

Implementations§

Source§

impl Nc4File

Source

pub fn new() -> Self

Create a new empty NetCDF-4 file.

Source

pub fn add_dimension(&mut self, name: &str, size: usize)

Add a fixed dimension.

Source

pub fn add_unlimited_dimension(&mut self, name: &str)

Add an unlimited dimension.

Source

pub fn extend_unlimited(&mut self)

Extend the unlimited dimension by one record.

Source

pub fn add_global_attribute(&mut self, key: &str, value: &str)

Add a global attribute.

Source

pub fn get_global_attribute(&self, key: &str) -> Option<&str>

Get a global attribute.

Source

pub fn get_dimension_size(&self, name: &str) -> Option<usize>

Get a dimension size.

Source

pub fn is_unlimited(&self, name: &str) -> bool

Whether a dimension is unlimited.

Source

pub fn add_variable(&mut self, var: Nc4Variable)

Add a variable to the root group.

Source

pub fn get_variable(&self, name: &str) -> Option<&Nc4Variable>

Get a variable from the root group.

Source

pub fn add_group(&mut self, group: Nc4Group)

Add a named sub-group to the root.

Source

pub fn get_group(&self, name: &str) -> Option<&Nc4Group>

Get a sub-group by name from the root.

Source

pub fn total_variable_count(&self) -> usize

All variable count (all groups).

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize to a simple CDL-based binary envelope.

Layout: OXNC4 magic (5 bytes) + payload length u32 LE + CDL-like text payload.

The CDL payload stores global attributes, dimensions, unlimited size, and root variable names as a simple key=value text block.

Trait Implementations§

Source§

impl Clone for Nc4File

Source§

fn clone(&self) -> Nc4File

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Nc4File

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Nc4File

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.