Skip to main content

GAFBaseParams

Struct GAFBaseParams 

Source
pub struct GAFBaseParams {
    pub block_size: usize,
    pub gbwt_buffer_size: usize,
    pub reference_free: bool,
    pub store_quality_strings: bool,
    pub store_optional_fields: bool,
}
Expand description

GAF-base construction parameters.

Fields§

§block_size: usize

Number of alignments in a block (database row).

Default: Self::BLOCK_SIZE. Note that values 0 and 1 are functionally equivalent.

§gbwt_buffer_size: usize

GBWT construction buffer size in nodes.

Default: Self::GBWT_BUFFER_SIZE. Note that the buffer grows automatically if a path is longer than the initial buffer size.

§reference_free: bool

Build a reference-free GAF-base that stores sequences in table Nodes.

Default: false.

§store_quality_strings: bool

Store base quality strings for the alignments.

Default: true.

§store_optional_fields: bool

Store unknown optional fields with the alignments.

Default: true.

Implementations§

Source§

impl GAFBaseParams

Source

pub const BLOCK_SIZE: usize = 1000

Default block size in alignments.

Source

pub const GBWT_BUFFER_SIZE: usize = 100_000_000

Default GBWT construction buffer size in nodes.

Source

pub fn to_json(&self) -> String

Returns a JSON description of the parameters that can be stored as a tag.

Trait Implementations§

Source§

impl Clone for GAFBaseParams

Source§

fn clone(&self) -> GAFBaseParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GAFBaseParams

Source§

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

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

impl Default for GAFBaseParams

Source§

fn default() -> Self

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

impl PartialEq for GAFBaseParams

Source§

fn eq(&self, other: &GAFBaseParams) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for GAFBaseParams

Source§

impl StructuralPartialEq for GAFBaseParams

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.