_Condition

Struct _Condition 

Source
pub struct _Condition {
    pub name: String,
    pub control: bool,
    pub min_chunks: u8,
    pub max_chunks: u8,
    pub targets: Targets,
    pub single_off: Action,
    pub single_on: Action,
    pub multi_off: Action,
    pub multi_on: Action,
    pub no_map: Action,
    pub no_seq: Action,
}
Expand description

The _Condition struct holds the settings lifted from the TOML file, for each region of the flowcell or barcode.

Fields§

§name: String

The name of the Condition (Barcode/Region).

§control: bool

Is this Region/Barcode a control region / Barcode

§min_chunks: u8

The minimum number of read chunks that have to be captured for a read to be processed. Default if not met is to proceed.

§max_chunks: u8

The maximum number of read chunks that can be captured for a read. Default if exceed is to unblock.

§targets: Targets

The targets associated with the Condition.

§single_off: Action

The action to perform when an alignment returns one single primary mapping, outside of any target regions.

§single_on: Action

The action to perform when an alignment returns one single primary mapping, inside of a target regions.

§multi_off: Action

The action to perform when an alignment returns multiple primary mappings, all outside of any target regions.

§multi_on: Action

The action to perform when an alignment returns multiple primary mappings, at LEAST ONE of which is inside of a target region.

§no_map: Action

The action to perform when no alignments are returned for this read.

§no_seq: Action

The action to perform when no sequence is produced for this read sequence.

Implementations§

Source§

impl _Condition

Source

pub fn get_name(&self) -> &String

Getter for the name field

Source

pub fn set_name(&mut self, name: String)

Setter for the name field

Source

pub fn is_control(&self) -> bool

Getter for the control field

Source

pub fn set_control(&mut self, control: bool)

Setter for the control field

Source

pub fn get_min_chunks(&self) -> u8

Getter for the min_chunks field

Source

pub fn set_min_chunks(&mut self, min_chunks: u8)

Setter for the min_chunks field

Source

pub fn get_max_chunks(&self) -> u8

Getter for the max_chunks field

Source

pub fn set_max_chunks(&mut self, max_chunks: u8)

Setter for the max_chunks field

Source

pub fn get_targets(&self) -> &Targets

Getter for the targets field

Source

pub fn set_targets(&mut self, targets: Targets)

Setter for the targets field

Source

pub fn get_single_off(&self) -> &Action

Getter and Setter for the single_off field

Source

pub fn set_single_off(&mut self, single_off: Action)

Set the Action to take when a single primary mapping is found outside of any target regions.

Source

pub fn get_single_on(&self) -> &Action

Getter and Setter for the single_on field

Source

pub fn set_single_on(&mut self, single_on: Action)

Set the Action to take when a single primary mapping is found on of any target regions.

Source

pub fn get_multi_off(&self) -> &Action

Getter and Setter for the multi_off field

Source

pub fn set_multi_off(&mut self, multi_off: Action)

Getter and Setter for the multi_off field

Source

pub fn get_multi_on(&self) -> &Action

Getter and Setter for the multi_on field

Source

pub fn set_multi_on(&mut self, multi_on: Action)

Getter and Setter for the multi_off field

Source

pub fn get_no_map(&self) -> &Action

Getter and Setter for the no_map field

Source

pub fn set_no_map(&mut self, no_map: Action)

Getter and Setter for the multi_off field

Source

pub fn get_no_seq(&self) -> &Action

Getter and Setter for the no_seq field

Source

pub fn set_no_seq(&mut self, no_seq: Action)

Getter and Setter for the multi_off field

Trait Implementations§

Source§

impl Debug for _Condition

Source§

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

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

impl From<&Map<String, Value>> for _Condition

Source§

fn from(source: &Map<String, Value>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for _Condition

Source§

fn eq(&self, other: &_Condition) -> 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 StructuralPartialEq for _Condition

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, 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.
Source§

impl<T> Ungil for T
where T: Send,