Struct noodles_sam :: record :: Record Copy item path

impl Record

pub fn name(&self) -> Option<Name<'_>>

Returns the name.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.name().is_none());

pub fn flags(&self) -> Result<Flags>

Returns the flags.

§Examples

use noodles_sam::{self as sam, alignment::record::Flags};
let record = sam::Record::default();
assert_eq!(record.flags()?, Flags::UNMAPPED);

pub fn reference_sequence_id(&self, header: &Header) -> Option<Result<usize>>

Returns the reference sequence ID.

§Examples

use noodles_sam as sam;
let header = sam::Header::default();
let record = sam::Record::default();
assert!(record.reference_sequence_id(&header).is_none());

pub fn reference_sequence_name(&self) -> Option<ReferenceSequenceName<'_>>

Returns the reference sequence name.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.reference_sequence_name().is_none());

pub fn alignment_start(&self) -> Option<Result<Position>>

Returns the alignment start.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.alignment_start().is_none());

pub fn mapping_quality(&self) -> Option<Result<MappingQuality>>

Returns the mapping quality.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.mapping_quality().is_none());

pub fn cigar(&self) -> Cigar<'_>

Returns the CIGAR operations.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.cigar().is_empty());

pub fn mate_reference_sequence_id( &self, header: &Header ) -> Option<Result<usize>>

Returns the mate reference sequence ID.

§Examples

use noodles_sam as sam;
let header = sam::Header::default();
let record = sam::Record::default();
assert!(record.mate_reference_sequence_id(&header).is_none());

pub fn mate_reference_sequence_name(&self) -> Option<ReferenceSequenceName<'_>>

Returns the mate reference sequence name.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.mate_reference_sequence_name().is_none());

pub fn mate_alignment_start(&self) -> Option<Result<Position>>

Returns the mate alignment start.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.mate_alignment_start().is_none());

pub fn template_length(&self) -> Result<i32>

Returns the template length.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert_eq!(record.template_length()?, 0);

pub fn sequence(&self) -> Sequence<'_>

Returns the sequence.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.sequence().is_empty());

pub fn quality_scores(&self) -> QualityScores<'_>

Returns the quality scores.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.quality_scores().is_empty());

pub fn data(&self) -> Data<'_>

Returns the data.

§Examples

use noodles_sam as sam;
let record = sam::Record::default();
assert!(record.data().is_empty());

Trait Implementations§

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Record

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

Formats the value using the given formatter. Read more

impl Default for Record

fn default() -> Record

Returns the “default value” for a type. Read more

impl PartialEq for Record

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

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

1.0.0 · source§

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 Record for Record

fn name(&self) -> Option<Box<dyn Name + '_>>

Returns the name.

fn flags(&self) -> Result<Flags>

Returns the flags.

fn reference_sequence_id<'r, 'h: 'r>( &'r self, header: &'h Header ) -> Option<Result<usize>>

Returns the reference sequence ID.

fn alignment_start(&self) -> Option<Result<Position>>

Returns the alignment start.

fn mapping_quality(&self) -> Option<Result<MappingQuality>>

Returns the mapping quality.

fn cigar(&self) -> Box<dyn Cigar + '_>

Returns the CIGAR operations.

fn mate_reference_sequence_id<'r, 'h: 'r>( &'r self, header: &'h Header ) -> Option<Result<usize>>

Returns the mate reference sequence ID.

fn mate_alignment_start(&self) -> Option<Result<Position>>

Returns the mate alignment start.

fn template_length(&self) -> Result<i32>

Returns the template length.

fn sequence(&self) -> Box<dyn Sequence + '_>

Returns the sequence.

fn quality_scores(&self) -> Box<dyn QualityScores + '_>

Returns the quality scores.

fn data(&self) -> Box<dyn Data + '_>

Returns the data.

fn reference_sequence<'h>( &self, header: &'h Header ) -> Option<Result<(&'h BStr, &'h Map<ReferenceSequence>)>>

Returns the associated reference sequence.

fn mate_reference_sequence<'h>( &self, header: &'h Header ) -> Option<Result<(&'h BStr, &'h Map<ReferenceSequence>)>>

Returns the associated mate reference sequence.

fn alignment_span(&self) -> Result<Option<usize>>

Returns the alignment span.

fn alignment_end(&self) -> Option<Result<Position>>

Calculates the end position.

impl Eq for Record

impl StructuralPartialEq for Record

Auto Trait Implementations§

impl UnwindSafe for Record

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more