Struct noodles_tabix::Reader
source · [−]pub struct Reader<R> { /* private fields */ }
Expand description
A tabix reader.
Consider using crate::read
to read the entire index at once.
Implementations
sourceimpl<R> Reader<R> where
R: Read,
impl<R> Reader<R> where
R: Read,
sourcepub fn new(reader: R) -> Self
pub fn new(reader: R) -> Self
Creates a tabix reader.
Examples
use noodles_tabix as tabix;;
let reader = File::open("sample.vcf.gz.tbi").map(tabix::Reader::new)?;
sourcepub fn read_index(&mut self) -> Result<Index>
pub fn read_index(&mut self) -> Result<Index>
Reads the tabix index.
The position of the stream is expected to be at the beginning.
Examples
use noodles_tabix as tabix;;
let mut reader = File::open("sample.vcf.gz.tbi").map(tabix::Reader::new)?;
let index = reader.read_index()?;
Auto Trait Implementations
impl<R> RefUnwindSafe for Reader<R> where
R: RefUnwindSafe,
impl<R> Send for Reader<R> where
R: Send,
impl<R> Sync for Reader<R> where
R: Sync,
impl<R> Unpin for Reader<R> where
R: Unpin,
impl<R> UnwindSafe for Reader<R> where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more