Csi

Struct Csi 

Source
pub struct Csi { /* private fields */ }
Expand description

A struct representing CSI index file content

Implementations§

Source§

impl Csi

Source

pub fn from_path(p: impl AsRef<Path>) -> Result<Self>

Create Csi from a path to a *.csi file

Source

pub fn get_bin_id(&self, beg: i64, end: i64) -> u32

Convert positional coordinate range to a bin number

beg, end`` coordinates are 0-based. It is exclusive for end. For some reason, not all length bin are searchable. It is seems that setting endtobeg` + 1 works well.

Source

pub fn get_bin_details(&self, seqid: usize, bin_id: u32) -> Result<&CsiBin>

Get CsiBin based the chromosome id and bin number.

The return CsiBin can provide details of the included chunks.

Source

pub fn get_bin_limit(&self) -> u32

Get the max possible bin number in theory. Note, the maximum bin may not be present in the Csi index file.

Trait Implementations§

Source§

impl Debug for Csi

Source§

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

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

impl Default for Csi

Source§

fn default() -> Csi

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

Auto Trait Implementations§

§

impl Freeze for Csi

§

impl RefUnwindSafe for Csi

§

impl Send for Csi

§

impl Sync for Csi

§

impl Unpin for Csi

§

impl UnwindSafe for Csi

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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.