Struct noodles_sam::alignment::record::data::field::tag::Tag

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

An alignment record data field tag.

Implementations

impl Tag

pub const MIN_MAPPING_QUALITY: Self = _

The smallest template-independent mapping quality in the template (AM).

pub const ALIGNMENT_SCORE: Self = _

Alignment score generated by aligner (AS).

pub const SAMPLE_BARCODE_SEQUENCE: Self = _

Barcode sequence identifying the sample (BC).

pub const BASE_ALIGNMENT_QUALITY_OFFSETS: Self = _

Offset to base alignment quality (BAQ) (BQ).

pub const ORIGINAL_UMI_QUALITY_SCORES: Self = _

Phred quality of the unique molecular barcode bases in the OX tag (BZ).

pub const CELL_BARCODE_ID: Self = _

Cell identifier (CB).

pub const NEXT_HIT_REFERENCE_SEQUENCE_NAME: Self = _

Reference name of the next hit (CC).

pub const CIGAR: Self = _

BAM only: CIGAR in BAM’s binary encoding if (and only if) it consists of > 65535 operators (CG).

pub const COLOR_EDIT_DISTANCE: Self = _

Edit distance between the color sequence and the color reference (see also NM) (CM).

pub const COMMENT: Self = _

Free-text comments (CO).

pub const NEXT_HIT_POSITION: Self = _

Leftmost coordinate of the next hit (CP).

pub const COLOR_QUALITY_SCORES: Self = _

Color read base qualities (CQ).

pub const CELL_BARCODE_SEQUENCE: Self = _

Cellular barcode sequence bases (uncorrected) (CR).

pub const COLOR_SEQUENCE: Self = _

Color read sequence (CS).

pub const COMPLETE_READ_ANNOTATIONS: Self = _

Complete read annotation tag, used for consensus annotation dummy features (CT).

pub const CELL_BARCODE_QUALITY_SCORES: Self = _

Phred quality of the cellular barcode sequence in the CR tag (CY).

pub const NEXT_HIT_SEQUENCE: Self = _

The 2nd most likely base calls (E2).

pub const SEGMENT_INDEX: Self = _

The index of segment in the template (FI).

pub const SEGMENT_SUFFIX: Self = _

Segment suffix (FS).

pub const ALTERNATIVE_SEQUENCE: Self = _

Flow signal intensities (FZ).

pub const RESERVED_GC: Self = _

Reserved for backwards compatibility reasons (GC).

pub const RESERVED_GQ: Self = _

Reserved for backwards compatibility reasons (GQ).

pub const RESERVED_GS: Self = _

Reserved for backwards compatibility reasons (GS).

pub const PERFECT_HIT_COUNT: Self = _

Number of perfect hits (H0).

pub const ONE_DIFFERENCE_HIT_COUNT: Self = _

Number of 1-difference hits (see also NM) (H1).

pub const TWO_DIFFERENCE_HIT_COUNT: Self = _

Number of 2-difference hits (H2).

pub const HIT_INDEX: Self = _

Query hit index (HI).

pub const TOTAL_HIT_COUNT: Self = _

Query hit total count (IH).

pub const LIBRARY: Self = _

Library (LB).

pub const MATE_CIGAR: Self = _

CIGAR string for mate/next segment (MC).

pub const MISMATCHED_POSITIONS: Self = _

String encoding mismatched and deleted reference bases (MD).

pub const RESERVED_MF: Self = _

Reserved for backwards compatibility reasons (MF).

pub const UMI_ID: Self = _

Molecular identifier (MI).

A string that uniquely identifies the molecule from which the record was derived.

pub const BASE_MODIFICATION_PROBABILITIES: Self = _

Base modification probabilities (ML).

pub const BASE_MODIFICATIONS: Self = _

Base modifications / methylation (MM).

pub const BASE_MODIFICATION_SEQUENCE_LENGTH: Self = _

Length of sequence at the time MM and ML were produced (MN).

pub const MATE_MAPPING_QUALITY: Self = _

Mapping quality of the mate/next segment (MQ).

pub const ALIGNMENT_HIT_COUNT: Self = _

Number of reported alignments that contain the query in the current record (NH).

pub const EDIT_DISTANCE: Self = _

Edit distance to the reference (NM).

pub const ORIGINAL_ALIGNMENT: Self = _

Original alignment (OA).

pub const ORIGINAL_CIGAR: Self = _

Original CIGAR (deprecated; use OA instead) (OC).

pub const ORIGINAL_POSITION: Self = _

Original mapping position (deprecated; use OA instead) (OP).

pub const ORIGINAL_QUALITY_SCORES: Self = _

Original base quality (OQ).

pub const ORIGINAL_UMI_BARCODE_SEQUENCE: Self = _

Original unique molecular barcode bases (OX).

pub const PROGRAM: Self = _

Program (PG).

pub const TEMPLATE_LIKELIHOOD: Self = _

Phred likelihood of the template (PQ).

pub const PADDED_READ_ANNOTATIONS: Self = _

Read annotations for parse of the padded read sequence (PT).

pub const PLATFORM_UNIT: Self = _

Platform unit (PU).

pub const MATE_QUALITY_SCORES: Self = _

Phred quality of the mate/next segment sequence in the R2 tag (Q2).

pub const SAMPLE_BARCODE_QUALITY_SCORES: Self = _

Phred quality of the sample barcode sequence in the BC tag (QT).

pub const UMI_QUALITY_SCORES: Self = _

Quality score of the unique molecular identifier in the RX tag (QX).

pub const MATE_SEQUENCE: Self = _

Sequence of the mate/next segment in the template (R2).

pub const READ_GROUP: Self = _

Read group (RG).

pub const RESERVED_RT: Self = _

Reserved for backwards compatibility reasons (RT).

pub const UMI_SEQUENCE: Self = _

Sequence bases of the (possibly corrected) unique molecular identifier (RX).

pub const RESERVED_S2: Self = _

Reserved for backwards compatibility reasons (S2).

pub const OTHER_ALIGNMENTS: Self = _

Other canonical alignments in a chimeric alignment (SA).

pub const TEMPLATE_MAPPING_QUALITY: Self = _

Template-independent mapping quality (SM).

pub const RESERVED_SQ: Self = _

Reserved for backwards compatibility reasons (SQ).

pub const SEGMENT_COUNT: Self = _

The number of segments in the template (TC).

pub const TRANSCRIPT_STRAND: Self = _

Transcript strand (TS).

pub const NEXT_HIT_QUALITY_SCORES: Self = _

Phred probability of the 2nd call being wrong conditional on the best being wrong (U2).

pub const SEGMENT_LIKELIHOOD: Self = _

Phred likelihood of the segment, conditional on the mapping being correct (UQ).

pub const fn new(a: u8, b: u8) -> Self

Creates a tag.

Examples

use noodles_sam::alignment::record::data::field::Tag;
let tag = Tag::new(b'x', b'n');

Trait Implementations

impl AsRef<[u8; 2]> for Tag

fn as_ref(&self) -> &[u8; 2]

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8; 2]> for Tag

fn borrow(&self) -> &[u8; 2]

Immutably borrows from an owned value.

impl Clone for Tag

fn clone(&self) -> Tag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl From<[u8; 2]> for Tag

fn from(buf: [u8; 2]) -> Self

Converts to this type from the input type.

impl From<Tag> for [u8; 2]

fn from(tag: Tag) -> Self

Converts to this type from the input type.

impl Hash for Tag

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Tag

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

Restrict a value to a certain interval.

impl PartialEq<[u8; 2]> for Tag

fn eq(&self, other: &[u8; 2]) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Tag

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Tag

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Tag

impl Eq for Tag

impl StructuralPartialEq for Tag