Struct Record

pub struct Record { /* private fields */ }

A FASTA index record.

Implementations

impl Record

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

where N: Into<Vec<u8>>,

Creates a FASTA index record.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);

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

Returns the record name.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);
assert_eq!(record.name(), b"sq0");

pub fn len(&self) -> u64

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

Returns the length of the sequence.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);
assert_eq!(record.len(), 8);

pub fn length(&self) -> u64

Returns the length of the sequence.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);
assert_eq!(record.length(), 8);

pub fn offset(&self) -> u64

Returns the offset from the start.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);
assert_eq!(record.offset(), 4);

pub fn line_bases(&self) -> u64

Returns the number of bases in a line.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);
assert_eq!(record.line_bases(), 80);

pub fn line_width(&self) -> u64

Returns the number of characters in a line.

Examples

use noodles_fasta::fai;
let record = fai::Record::new("sq0", 8, 4, 80, 81);
assert_eq!(record.line_width(), 81);

pub fn query(&self, interval: Interval) -> Result<u64>

Returns the start position of the given interval.

Examples

use noodles_core::{region::Interval, Position};
use noodles_fasta::fai;

let record = fai::Record::new("sq0", 10946, 4, 80, 81);
let interval = Interval::from(..);

assert_eq!(record.query(interval)?, 4);
Ok::<_, std::io::Error>(())

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

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