pub struct BigWigRead<R> { /* private fields */ }Expand description
The struct used to read a bigWig file
Implementations§
Source§impl<R> BigWigRead<R>
impl<R> BigWigRead<R>
Source§impl<R> BigWigRead<R>where
R: SeekableRead,
impl<R> BigWigRead<R>where
R: SeekableRead,
Sourcepub fn cached(self) -> BigWigRead<CachedBBIFileRead<R>>
pub fn cached(self) -> BigWigRead<CachedBBIFileRead<R>>
Converts this BigWigRead`` to where the BBIFileRead` caches index
access and block data
Source§impl<R> BigWigRead<R>where
R: BBIFileRead,
impl<R> BigWigRead<R>where
R: BBIFileRead,
Sourcepub fn open(read: R) -> Result<Self, BigWigReadOpenError>
pub fn open(read: R) -> Result<Self, BigWigReadOpenError>
Opens a new BigWigRead with for a given type that implements both Read and Seek
Sourcepub fn with_info(info: BBIFileInfo, read: R) -> Self
pub fn with_info(info: BBIFileInfo, read: R) -> Self
Does not check if the passed R matches the provided info (including if the R is a bigWig at all!)
Sourcepub fn inner_read(&self) -> &R
pub fn inner_read(&self) -> &R
Gets a reference to the inner R type, in order to access any info
Sourcepub fn get_summary(&mut self) -> Result<Summary>
pub fn get_summary(&mut self) -> Result<Summary>
Returns the summary data from bigWig
Note: For version 1 of bigWigs, there is no total summary. In that
case, 0 is returned for all of the summary except total items. If this
matters to you, you can check the version using
info().header.version > 1.
Sourcepub fn get_interval<'a>(
&'a mut self,
chrom_name: &str,
start: u32,
end: u32,
) -> Result<impl Iterator<Item = Result<Value, BBIReadError>> + 'a, BBIReadError>
pub fn get_interval<'a>( &'a mut self, chrom_name: &str, start: u32, end: u32, ) -> Result<impl Iterator<Item = Result<Value, BBIReadError>> + 'a, BBIReadError>
For a given chromosome, start, and end, returns an Iterator of the
intersecting Values. The resulting iterator takes a mutable reference
of this BigWigRead.
Sourcepub fn get_interval_move(
self,
chrom_name: &str,
start: u32,
end: u32,
) -> Result<impl Iterator<Item = Result<Value, BBIReadError>>, BBIReadError>
pub fn get_interval_move( self, chrom_name: &str, start: u32, end: u32, ) -> Result<impl Iterator<Item = Result<Value, BBIReadError>>, BBIReadError>
For a given chromosome, start, and end, returns an Iterator of the
intersecting Values. The resulting iterator takes this BigWigRead
by value.
Sourcepub fn get_zoom_interval<'a>(
&'a mut self,
chrom_name: &str,
start: u32,
end: u32,
reduction_level: u32,
) -> Result<impl Iterator<Item = Result<ZoomRecord, BBIReadError>> + 'a, ZoomIntervalError>
pub fn get_zoom_interval<'a>( &'a mut self, chrom_name: &str, start: u32, end: u32, reduction_level: u32, ) -> Result<impl Iterator<Item = Result<ZoomRecord, BBIReadError>> + 'a, ZoomIntervalError>
For a given chromosome, start, and end, returns an Iterator of the
intersecting ZoomRecords.
Sourcepub fn get_zoom_interval_move<'a>(
self,
chrom_name: &str,
start: u32,
end: u32,
reduction_level: u32,
) -> Result<impl Iterator<Item = Result<ZoomRecord, BBIReadError>>, ZoomIntervalError>
pub fn get_zoom_interval_move<'a>( self, chrom_name: &str, start: u32, end: u32, reduction_level: u32, ) -> Result<impl Iterator<Item = Result<ZoomRecord, BBIReadError>>, ZoomIntervalError>
For a given chromosome, start, and end, returns an Iterator of the
intersecting ZoomRecords.