Struct IndexEntry 

pub struct IndexEntry { /* private fields */ }

Properties that describe a given data chunk.

GSD files store a set of arrays, uniquely identified by their name and frame*. The GsdFile::find_chunk method search for a matching index entry. The returned IndexEntry (if present) also carries information about the dimension and type of the array.

Implementations

impl IndexEntry

pub fn frame(&self) -> u64

Trajectory frame number.

pub fn rows(&self) -> u64

Number of rows in the array.

pub fn columns(&self) -> u32

Number of columns in the array.

pub fn data_type(&self) -> Option<DataType>

The array’s data type.

Returns Some(data_type) when the type is known and None when it is not.

Example

use hoomd_gsd::file_layer::{DataType, IndexEntry};

match index_entry.data_type() {
    Some(DataType::F32) => do_something(),
    _ => (),
}

Trait Implementations

impl Clone for IndexEntry

fn clone(&self) -> IndexEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexEntry

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

Formats the value using the given formatter.

impl Ord for IndexEntry

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IndexEntry

fn eq(&self, other: &IndexEntry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IndexEntry

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for IndexEntry

impl StructuralPartialEq for IndexEntry