Skip to main content

ClassicFile

Struct ClassicFile 

Source
pub struct ClassicFile { /* private fields */ }
Expand description

An opened classic-format NetCDF file (CDF-1, CDF-2, or CDF-5).

Implementations§

Source§

impl ClassicFile

Source

pub fn read_variable<T: NcReadType>(&self, name: &str) -> Result<ArrayD<T>>

Read a variable’s data as an ndarray of the specified type.

The type parameter T must match the variable’s NetCDF type. For example, use f32 for NC_FLOAT variables and f64 for NC_DOUBLE variables.

Source

pub fn read_variable_as_f64(&self, name: &str) -> Result<ArrayD<f64>>

Read a variable’s data with automatic type promotion to f64.

This reads any numeric variable and converts all values to f64, which is convenient for analysis but may lose precision for i64/u64.

Source

pub fn read_variable_as_string(&self, name: &str) -> Result<String>

Read a char variable as a String (or Vec for multi-dimensional).

Source

pub fn read_variable_as_strings(&self, name: &str) -> Result<Vec<String>>

Read a char variable as a flat vector of strings.

For 2-D and higher char arrays, the last dimension is interpreted as the string length and the leading dimensions are flattened.

Source

pub fn read_variable_slice<T: NcReadType>( &self, name: &str, selection: &NcSliceInfo, ) -> Result<ArrayD<T>>

Read a slice (hyperslab) of a variable.

Classic variables are read directly from the on-disk byte ranges for arbitrary selections.

Source

pub fn read_variable_slice_as_f64( &self, name: &str, selection: &NcSliceInfo, ) -> Result<ArrayD<f64>>

Read a slice with automatic type promotion to f64.

Source§

impl ClassicFile

Source

pub fn open(path: &Path, format: NcFormat) -> Result<Self>

Open a classic NetCDF file from disk using memory-mapping.

Source

pub fn from_bytes(bytes: &[u8], format: NcFormat) -> Result<Self>

Open a classic NetCDF file from in-memory bytes.

Source

pub fn from_mmap(mmap: Mmap, format: NcFormat) -> Result<Self>

Open a classic NetCDF file from an existing memory map (avoids double mmap).

Source

pub fn format(&self) -> NcFormat

The file format (Classic, Offset64, or Cdf5).

Source

pub fn root_group(&self) -> &NcGroup

The root group containing all dimensions, variables, and global attributes.

Source

pub fn numrecs(&self) -> u64

Number of records in the unlimited dimension.

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.