Struct noodles_fastq::fai::Record

pub struct Record { /* private fields */ }

A FASTQ index record.

Implementations

impl Record

pub fn new<N>( name: N, length: u64, sequence_offset: u64, line_bases: u64, line_width: u64, quality_scores_offset: u64 ) -> Self

where N: Into<String>,

Creates a FASTQ index record.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);

pub fn name(&self) -> &str

Returns the name.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.name(), "sq0");

pub fn len(&self) -> u64

👎Deprecated since 0.9.0: Use Record::length instead.

Returns the length of the sequence.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.len(), 8);

pub fn length(&self) -> u64

Returns the length of the sequence.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.length(), 8);

pub fn sequence_offset(&self) -> u64

Returns the offset to the sequence from the start.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.sequence_offset(), 4);

pub fn line_bases(&self) -> u64

Returns the number of bases in the sequence.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.line_bases(), 8);

pub fn line_width(&self) -> u64

Returns the number of characters in the sequence.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.line_width(), 9);

pub fn quality_scores_offset(&self) -> u64

Returns the offset to the quality scores from the start.

Examples

use noodles_fastq::fai;
let record = fai::Record::new("sq0", 8, 4, 8, 9, 15);
assert_eq!(record.quality_scores_offset(), 15);

Trait Implementations

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

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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 ==.

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

impl StructuralPartialEq for Record