Struct noodles_fasta::record::Record

pub struct Record { /* private fields */ }

A FASTA record.

Implementations

impl Record

pub fn new(definition: Definition, sequence: Sequence) -> Self

Creates a FASTA record from a definition and sequence.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};
let definition = Definition::new("sq0", None);
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition, sequence);

pub fn definition(&self) -> &Definition

Returns the record definition.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};

let definition = Definition::new("sq0", None);
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition.clone(), sequence);

assert_eq!(record.definition(), &definition);

pub fn reference_sequence_name(&self) -> &str

👎Deprecated since 0.2.0: Use name instead.

Returns the reference sequence name.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};

let definition = Definition::new("sq0", None);
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition, sequence);

assert_eq!(record.reference_sequence_name(), "sq0");

pub fn name(&self) -> &str

Returns the record name.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};

let definition = Definition::new("sq0", None);
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition, sequence);

assert_eq!(record.name(), "sq0");

pub fn description(&self) -> Option<&str>

Returns the description.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};

let definition = Definition::new("sq0", Some(String::from("LN:4")));
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition, sequence);

assert_eq!(record.description(), Some("LN:4"));

pub fn sequence(&self) -> &Sequence

Returns the sequence.

Examples

use noodles_fasta::{self as fasta, record::{Definition, Sequence}};

let definition = Definition::new("sq0", None);
let sequence = Sequence::from(b"ACGT".to_vec());
let record = fasta::Record::new(definition, sequence.clone());

assert_eq!(record.sequence(), &sequence);

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a copy of the value.

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

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

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

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

impl StructuralPartialEq for Record