Skip to main content

BbiWriterOptions

Struct BbiWriterOptions 

Source
pub struct BbiWriterOptions {
    pub kind: BbiKind,
    pub chr_sizes: Option<ChrMap>,
    pub fields: IndexMap<String, String>,
    pub items_per_slot: Option<usize>,
    pub block_size: u32,
    pub compression_level: u32,
    pub parallel: i64,
    pub section_policy: SectionPolicy,
    pub cost_model: CostModel,
}

Fields§

§kind: BbiKind§chr_sizes: Option<ChrMap>

Declared sizes. Every written coordinate is checked against them, and a written id resolves against their keys the way a read one does. None infers each chromosome’s size from what is written.

§fields: IndexMap<String, String>

bigBed only. The first three must be the coordinates.

§items_per_slot: Option<usize>§block_size: u32§compression_level: u32§parallel: i64§section_policy: SectionPolicy

How a wig section decides between widening its encoding and closing. Every setting writes a valid file; they differ in how big it is. See SectionPolicy and examples/section_policy.rs.

§cost_model: CostModel

The constants behind SectionPolicy::Cost. Exposed for the same reason: so the model can be measured rather than argued about.

Trait Implementations§

Source§

impl Default for BbiWriterOptions

Source§

fn default() -> Self

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.