Struct BinaryDataArray 

pub struct BinaryDataArray { /* private fields */ }

BinaryDataArray represents the tag and captures information required to read and parse the stored binary data.

Implementations

impl BinaryDataArray

pub fn new() -> Self

Create a new BinaryDataArray with no CV params

pub fn array_type(&self) -> Option<BinaryDataArrayType>

Return the BinaryDataArrayType (e.g. m/z array, intensity array) based on the CV params stored within.

pub fn binary_type(&self) -> BinaryDataType

Return the BinaryDataType (e.g. f64, f32, …) based on the CV params stored within.

pub fn compression(&self) -> Compression

Return the Compression (e.g. None, Z-lib, …) used to compress the binary data, based on the CV params stored within.

pub fn array_length(&self) -> Option<u64>

Return the number of elements in the array.

pub fn encoded_length(&self) -> Option<u64>

Return the number of bytes needed to store the array (in the specified data type, and after compression).

pub fn offset(&self) -> Option<u64>

Return the file offset depicting where the array is stored.

pub fn is_data_external(&self) -> bool

Return true if the array is stored in an external file (e.g. ibd). Always true for imzML files.

Trait Implementations

impl Clone for BinaryDataArray

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryDataArray

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

Formats the value using the given formatter.

impl Default for BinaryDataArray

fn default() -> Self

Returns the “default value” for a type.

impl HasCVParams for BinaryDataArray

fn add_cv_param(&mut self, param: CVParam)

Add a cvParam to the tag.

fn cv_params(&self) -> &Vec<CVParam>

Return access to the list of cvParams currently associated with the tag.

fn cv_params_mut(&mut self) -> &mut Vec<CVParam>

Return mutable access to the list of cvParams currently associated with the tag.

fn add_user_param(&mut self, param: UserParam)

Add a userParam to the tag.

fn user_params(&self) -> &Vec<UserParam>

Return access to all userParams.

fn clone_params(&self) -> Vec<CVParam>

Clone the current parameters into a Vec<CVParam<'a>>.

fn remove_children_of(&mut self, ontology: &Ontology, parent_id: &str)

Remove any cvParam which has a term that is the child of the of the supplied term (parent_id).

fn children_of(&self, ontology: &Ontology, parent_id: &str) -> Vec<&CVParam>

Return all cvParams which have a term that is the child of the of the supplied term (parent_id).

fn search_cv_params(&self, accession: &str) -> Option<&CVParam>

Return cvParam with supplied term (accession) if present, None otherwise.

fn write_params_xml<W: Write>( &self, writer: &mut Writer<W>, ) -> Result<(), Error>

Write the params (cvParam and userParam) as XML to the supplied writer.

impl HasParamGroupRefs for BinaryDataArray

fn add_param_group_ref(&mut self, param_group_ref: ReferenceableParamGroupRef)

Add a referenceableParamGroupRef to the tag.

fn param_group_refs(&self) -> &Vec<ReferenceableParamGroupRef>

Returns a reference to list of referenceableParamGroupRef

fn clone_params_with_groups(&self) -> Vec<CVParam>

Returns a Vec containing cloned versions of all cvParams

fn search_param_groups(&self, accession: &str) -> Option<&CVParam>

Search param groups for

fn write_ref_param_groups_xml<W: Write>( &self, writer: &mut Writer<W>, ) -> Result<(), Error>

Write the references (referenceableParamGroupRef) as XML to the supplied writer.

impl MzMLTag for BinaryDataArray

fn parse_start_tag<B: BufRead>( parser: &mut MzMLReader<B>, start_event: &BytesStart<'_>, ) -> Result<Option<Self>, FatalParseError>

where Self: Sized,

Parse the start tag (capture any attributes, noting any missing or extra as errors).

fn parse_xml<B: BufRead>( &mut self, parser: &mut MzMLReader<B>, buffer: &mut Vec<u8>, ) -> Result<(), FatalParseError>

Parse the child tags (if necessary). This is only called if there are expected to be child tags.

fn tag() -> Tag

Returns the tag being described

fn write_xml<W: Write>(&self, writer: &mut Writer<W>) -> Result<(), Error>

Write the tag in XML format.