Struct FileFormat

pub struct FileFormat { /* private fields */ }

A VCF header file format.

Implementations

impl FileFormat

pub const fn new(major: u32, minor: u32) -> Self

Creates a file format.

Examples

use noodles_vcf::header::FileFormat;
let file_format = FileFormat::new(4, 5);

pub const fn major(&self) -> u32

Returns the major version.

Examples

use noodles_vcf::header::FileFormat;
let file_format = FileFormat::new(4, 5);
assert_eq!(file_format.major(), 4);

pub const fn minor(&self) -> u32

Returns the minor version.

Examples

use noodles_vcf::header::FileFormat;
let file_format = FileFormat::new(4, 5);
assert_eq!(file_format.minor(), 5);

Trait Implementations

impl Clone for FileFormat

fn clone(&self) -> FileFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileFormat

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

Formats the value using the given formatter.

impl Default for FileFormat

fn default() -> Self

Returns the “default value” for a type.

impl Ord for FileFormat

fn cmp(&self, other: &FileFormat) -> 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 FileFormat

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

fn partial_cmp(&self, other: &FileFormat) -> 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 Copy for FileFormat

impl Eq for FileFormat

impl StructuralPartialEq for FileFormat