Writer

Struct Writer 

Source
pub struct Writer<W>
where W: Write,
{ /* private fields */ }
Expand description

A Fasta writer.

Implementations§

Source§

impl Writer<File>

Source

pub fn to_file<P>(path: P) -> Result<Writer<File>, Error>
where P: AsRef<Path>,

Write to the given file path.

Source

pub fn to_file_with_capacity<P>( capacity: usize, path: P, ) -> Result<Writer<File>, Error>
where P: AsRef<Path>,

Write to the given file path and a buffer capacity

Source§

impl<W> Writer<W>
where W: Write,

Source

pub fn new(writer: W) -> Writer<W>

Create a new Fasta writer.

Source

pub fn with_capacity(capacity: usize, writer: W) -> Writer<W>

Create a new Fasta writer with a capacity of write buffer

Source

pub fn from_bufwriter(bufwriter: BufWriter<W>) -> Writer<W>

Create a new Fasta writer with a given BufWriter

Source

pub fn write_record(&mut self, record: &Record) -> Result<(), Error>

Directly write a fasta::Record.

§Errors

If there is an issue writing to the Writer.

§Examples
use bio::io::fasta::{Record, Writer};
use std::fs;
use std::io;
use std::path::Path;

let path = Path::new("test.fa");
let file = fs::File::create(path).unwrap();
{
    let handle = io::BufWriter::new(file);
    let mut writer = Writer::new(handle);
    let record = Record::with_attrs("id", Some("desc"), b"ACGT");

    let write_result = writer.write_record(&record);
    assert!(write_result.is_ok());
}

let actual = fs::read_to_string(path).unwrap();
let expected = ">id desc\nACGT\n";

assert!(fs::remove_file(path).is_ok());
assert_eq!(actual, expected)
Source

pub fn write( &mut self, id: &str, desc: Option<&str>, seq: &[u8], ) -> Result<(), Error>

Write a Fasta record with given id, optional description and sequence.

Source

pub fn flush(&mut self) -> Result<(), Error>

Flush the writer, ensuring that everything is written.

Trait Implementations§

Source§

impl<W> Debug for Writer<W>
where W: Debug + Write,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<W> Freeze for Writer<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Writer<W>
where W: RefUnwindSafe,

§

impl<W> Send for Writer<W>
where W: Send,

§

impl<W> Sync for Writer<W>
where W: Sync,

§

impl<W> Unpin for Writer<W>
where W: Unpin,

§

impl<W> UnwindSafe for Writer<W>
where W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V