Struct bio::io::fasta::Record

pub struct Record { /* private fields */ }

A FASTA record.

Implementations

impl Record

pub fn new() -> Self

Create a new instance.

pub fn with_attrs(id: &str, desc: Option<&str>, seq: TextSlice<'_>) -> Self

Create a new Record from given attributes.

Examples

use bio::io::fasta::Record;

let read_id = "read1";
let description = Some("sampleid=foobar");
let sequence = b"ACGT";
let record = Record::with_attrs(read_id, description, sequence);

assert_eq!(">read1 sampleid=foobar\nACGT\n", record.to_string())

pub fn is_empty(&self) -> bool

Check if record is empty.

pub fn check(&self) -> Result<(), &str>

Check validity of Fasta record.

pub fn id(&self) -> &str

Return the id of the record.

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

Return descriptions if present.

pub fn seq(&self) -> TextSlice<'_>

Return the sequence of the record.

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<'de> Deserialize<'de> for Record

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Record

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

Allows for using Record in a given formatter f. In general this is for creating a String representation of a Record and, optionally, writing it to a file.

Errors

Returns std::fmt::Error if there is an issue formatting to the stream.

Examples

Read in a Fasta Record and create a String representation of it.

use bio::io::fasta::Reader;
use std::fmt::Write;
// create a "fake" fasta file
let fasta: &'static [u8] = b">id comment1 comment2\nACGT\n";
let mut records = Reader::new(fasta).records().map(|r| r.unwrap());
let record = records.next().unwrap();

let mut actual = String::new();
// populate `actual` with a string representation of our record
write!(actual, "{}", record).unwrap();

let expected = std::str::from_utf8(fasta).unwrap();

assert_eq!(actual, expected)

impl Serialize for Record

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.