[−][src]Struct bam::sam::SamWriter
Writes records in SAM format.
Can be created as
let writer = SamWriter::from_path("out.sam", header).unwrap();
or using a builder
let writer = SamWriter::build() .header(header) .from_path("out.sam").unwrap();
You can clone a header from SAM/BAM reader or create one yourself.
You need to import RecordWriter to write records:
use bam::RecordWriter; let mut writer = bam::SamWriter::from_path("out.sam", header).unwrap(); let mut record = bam::Record::new(); // Filling the record. writer.write(&record).unwrap();
Methods
impl SamWriter<BufWriter<File>>
[src]
pub fn build() -> SamWriterBuilder
[src]
Create a builder.
pub fn from_path<P: AsRef<Path>>(path: P, header: Header) -> Result<Self>
[src]
Creates a SAM writer from a path and a header.
impl<W: Write> SamWriter<W>
[src]
pub fn from_stream(stream: W, header: Header) -> Result<Self>
[src]
Creates a SAM writer from a stream and a header. Preferably the stream should be wrapped
in a buffer writer, such as BufWriter
.
pub fn header(&self) -> &Header
[src]
Returns header.
pub fn flush(&mut self) -> Result<()>
[src]
Flushes contents to output.
Trait Implementations
impl<W: Write> RecordWriter for SamWriter<W>
[src]
Auto Trait Implementations
impl<W> Send for SamWriter<W> where
W: Send,
W: Send,
impl<W> Unpin for SamWriter<W> where
W: Unpin,
W: Unpin,
impl<W> Sync for SamWriter<W> where
W: Sync,
W: Sync,
impl<W> UnwindSafe for SamWriter<W> where
W: UnwindSafe,
W: UnwindSafe,
impl<W> RefUnwindSafe for SamWriter<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,