Struct noodles::cram::io::indexed_reader::IndexedReader

source ·
pub struct IndexedReader<R> { /* private fields */ }
Expand description

An indexed CRAM reader.

Implementations§

source§

impl<R> IndexedReader<R>
where R: Read,

source

pub fn new(inner: R, index: Vec<Record>) -> IndexedReader<R>

Creates an indexed CRAM reader.

source

pub fn get_ref(&self) -> &R

Returns a reference to the underlying reader.

source

pub fn get_mut(&mut self) -> &mut R

Returns a mutable reference to the underlying reader.

source

pub fn into_inner(self) -> R

Unwraps and returns the underlying reader.

source

pub fn reference_sequence_repository(&self) -> &Repository

Returns the reference sequence repository.

source

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

Reads the CRAM file definition.

source

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

Reads the SAM header.

source

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

Reads the SAM header.

source

pub fn read_data_container(&mut self) -> Result<Option<DataContainer>, Error>

Reads a data container.

source

pub fn records<'r>(&'r mut self, header: &'r Header) -> Records<'r, R>

Returns a iterator over records starting from the current stream position.

source

pub fn index(&self) -> &Vec<Record>

Returns the associated index.

source§

impl<R> IndexedReader<R>
where R: Read + Seek,

source

pub fn query<'a>( &'a mut self, header: &'a Header, region: &Region ) -> Result<Query<'a, R>, Error>

Returns an iterator over records that intersects the given region.

Auto Trait Implementations§

§

impl<R> Freeze for IndexedReader<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for IndexedReader<R>
where R: RefUnwindSafe,

§

impl<R> Send for IndexedReader<R>
where R: Send,

§

impl<R> Sync for IndexedReader<R>
where R: Sync,

§

impl<R> Unpin for IndexedReader<R>
where R: Unpin,

§

impl<R> UnwindSafe for IndexedReader<R>
where R: 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> 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> Same for T

§

type Output = T

Should always be Self
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