pub struct MaxSeqErrors { /* private fields */ }
Expand description

Struct of how many sequencing errrors are allowed

Implementations§

source§

impl MaxSeqErrors

source

pub fn new( sample_errors_option: Option<u16>, sample_barcode_size_option: Option<u16>, barcode_errors_option: Option<u16>, barcode_sizes: Vec<u16>, constant_errors_option: Option<u16>, constant_region_size: u16, min_quality: f32 ) -> Self

Create a new sequence error struct

Example
use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
source

pub fn max_constant_errors(&self) -> u16

Returns the maximum allowed constant region errors

Example
use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_constant_errors(), 6);
let barcode_sizes = vec![8,8,8];
let constant_errors_option = Some(3);
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_constant_errors(), 3);
source

pub fn max_sample_errors(&self) -> u16

Returns the maximum allowed sample barcode errors

Example
use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_sample_errors(), 2);
let barcode_sizes = vec![8,8,8];
let sample_errors_option = Some(3);
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_sample_errors(), 3);
source

pub fn max_barcode_errors(&self) -> &[u16]

Returns the maximum allowed errors within each counted barcode

Example
use barcode_count::info::MaxSeqErrors;

let sample_errors_option = None;
let sample_barcode_size_option = Some(10);
let barcode_errors_option = None;
let barcode_sizes = vec![8,8,8];
let constant_errors_option = None;
let constant_region_size = 30;
let min_quality = 0.0;
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_barcode_errors(), vec![1,1,1]);
let barcode_sizes = vec![8,8,8];
let barcode_errors_option = Some(2);
let mut max_sequence_errors = MaxSeqErrors::new(sample_errors_option, sample_barcode_size_option, barcode_errors_option, barcode_sizes, constant_errors_option, constant_region_size, min_quality);
assert_eq!(max_sequence_errors.max_barcode_errors(), vec![2,2,2]);

Trait Implementations§

source§

impl Clone for MaxSeqErrors

source§

fn clone(&self) -> MaxSeqErrors

Returns a copy 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 MaxSeqErrors

source§

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

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

impl Display for MaxSeqErrors

source§

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

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

impl PartialEq<MaxSeqErrors> for MaxSeqErrors

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for MaxSeqErrors

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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> ToOwned for Twhere T: Clone,

§

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> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

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 Twhere U: TryFrom<T>,

§

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.