Struct MappingQuality

pub struct MappingQuality(/* private fields */);

An alignment record mapping quality.

Mapping quality ranges from 0 to 254 (inclusive), where higher is better.

The value 255 is reserved as a marker for a missing mapping quality.

Implementations

impl MappingQuality

pub const MIN: Self = _

The minimum mapping quality (0).

pub const MAX: Self = _

The maximum mapping quality (254).

pub const fn new(n: u8) -> Option<Self>

Creates a mapping quality.

Examples

use noodles_sam::alignment::record::MappingQuality;
assert!(MappingQuality::new(8).is_some());
assert!(MappingQuality::new(255).is_none());

pub const fn get(&self) -> u8

Returns the inner value.

Examples

use noodles_sam::alignment::record::MappingQuality;
let mapping_quality = MappingQuality::new(8).unwrap();
assert_eq!(mapping_quality.get(), 8);

Trait Implementations

impl Clone for MappingQuality

fn clone(&self) -> MappingQuality

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MappingQuality

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

Formats the value using the given formatter.

impl Default for MappingQuality

fn default() -> MappingQuality

Returns the “default value” for a type.

impl From<MappingQuality> for u8

fn from(mapping_quality: MappingQuality) -> Self

Converts to this type from the input type.

impl Ord for MappingQuality

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

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

fn partial_cmp(&self, other: &MappingQuality) -> 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 TryFrom<u8> for MappingQuality

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(n: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MappingQuality

impl Eq for MappingQuality

impl StructuralPartialEq for MappingQuality