Struct Record

pub struct Record { /* private fields */ }

A FASTQ record.

Implementations

impl Record

pub fn new<S, Q>(definition: Definition, sequence: S, quality_scores: Q) -> Self

where S: Into<Vec<u8>>, Q: Into<Vec<u8>>,

Creates a FASTQ record.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");

pub fn definition(&self) -> &Definition

Returns the record definition.

pub fn definition_mut(&mut self) -> &mut Definition

Returns a mutable reference to the record definition.

pub fn name(&self) -> &BStr

Returns the name of the record.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
assert_eq!(record.name(), &b"r0"[..]);

pub fn name_mut(&mut self) -> &mut BString

Returns a mutable reference to the name.

Examples

use bstr::BString;
use noodles_fastq::{self as fastq, record::Definition};
let mut record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
*record.name_mut() = BString::from(b"r1");
assert_eq!(record.name(), &b"r1"[..]);

pub fn description(&self) -> &BStr

Returns the description of the record.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
assert!(record.description().is_empty());

pub fn description_mut(&mut self) -> &mut BString

Returns a mutable reference to the description.

Examples

use bstr::BString;
use noodles_fastq::{self as fastq, record::Definition};
let mut record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
*record.description_mut() = BString::from(b"LN=4");
assert_eq!(record.description(), &b"LN=4"[..]);

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

Returns the sequence of the record.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
assert_eq!(record.sequence(), b"AGCT");

pub fn sequence_mut(&mut self) -> &mut Vec<u8>

Returns a mutable reference to the sequence.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let mut record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
record.sequence_mut()[0] = b'C';
assert_eq!(record.sequence(), b"CGCT");

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

Returns the quality scores of the record.

The encoding of these scores are considered to be unknown; and it is up to the caller to decode them, if necessary.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
assert_eq!(record.quality_scores(), b"NDLS");

pub fn quality_scores_mut(&mut self) -> &mut Vec<u8>

Returns a mutable reference to the quality scores.

The encoding of these scores are considered to be unknown; and it is up to the caller to encode/decode them, if necessary.

Examples

use noodles_fastq::{self as fastq, record::Definition};
let mut record = fastq::Record::new(Definition::new("r0", ""), "AGCT", "NDLS");
*record.quality_scores_mut() = b"!!!!".to_vec();
assert_eq!(record.quality_scores(), b"!!!!");

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl Default for Record

fn default() -> Record

Returns the “default value” for a type.

impl PartialEq for Record

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

impl StructuralPartialEq for Record