Struct FileDefinition

pub struct FileDefinition { /* private fields */ }

A CRAM file definition.

The CRAM file definition holds the format version and file ID. See § 6 File definition (2020-06-22).

Implementations

impl FileDefinition

pub fn new(version: Version, file_id: [u8; 20]) -> Self

Creates a file definition.

Examples

use noodles_cram::{file_definition::Version, FileDefinition};
let file_definition = FileDefinition::new(Version::new(3, 0), [0; 20]);

pub fn version(&self) -> Version

Returns the file version.

This is also called the (major and minor) format number.

Examples

use noodles_cram::{file_definition::Version, FileDefinition};
let file_definition = FileDefinition::new(Version::new(3, 0), [0; 20]);
assert_eq!(file_definition.version(), Version::new(3, 0));

pub fn file_id(&self) -> &[u8]

Returns the file ID.

The file ID has a fixed length of 20 bytes. It can be any arbitrary identifier, e.g., the file name or a 160-bit checksum.

Examples

use noodles_cram::{file_definition::Version, FileDefinition};
let file_definition = FileDefinition::new(Version::new(3, 0), [0; 20]);
assert_eq!(file_definition.file_id(), [0; 20]);

Trait Implementations

impl Clone for FileDefinition

fn clone(&self) -> FileDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDefinition

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

Formats the value using the given formatter.

impl Default for FileDefinition

fn default() -> FileDefinition

Returns the “default value” for a type.

impl PartialEq for FileDefinition

fn eq(&self, other: &FileDefinition) -> 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 Eq for FileDefinition

impl StructuralPartialEq for FileDefinition