Struct noodles_sam::io::reader::Builder

source ·
pub struct Builder { /* private fields */ }
Expand description

A SAM reader builder.

Implementations§

source§

impl Builder

source

pub fn set_compression_method( self, compression_method: CompressionMethod ) -> Self

Sets the compression method.

§Examples
use noodles_sam::io::{reader::Builder, CompressionMethod};
let builder = Builder::default().set_compression_method(CompressionMethod::Bgzf);
source

pub fn build_from_path<P>(self, src: P) -> Result<Reader<Box<dyn BufRead>>>
where P: AsRef<Path>,

Builds a SAM reader from a path.

By default, the compression method will be autodetected. This can be overridden by using Self::set_compression_method.

§Examples
use noodles_sam::io::reader::Builder;
let reader = Builder::default().build_from_path("sample.sam")?;
source

pub fn build_from_reader<'r, R>( self, reader: R ) -> Result<Reader<Box<dyn BufRead + 'r>>>
where R: Read + 'r,

Builds a SAM reader from a reader.

§Examples
use noodles_sam::io::reader::Builder;
let reader = Builder::default().build_from_reader(io::empty());

Trait Implementations§

source§

impl Debug for Builder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Builder

source§

fn default() -> Builder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more