Struct Sample 

pub struct Sample {
    pub sample_id: String,
    pub barcode: String,
    pub read_structures: Option<Vec<ReadStructure>>,
    /* private fields */
}

Struct for describing a single sample and metadata associated with that sample.

Fields

sample_id: String

ID of the sample or library

barcode: String

DNA barcode associated with the sample

read_structures: Option<Vec<ReadStructure>>

Optional per-sample read structures (one per input FASTQ). When present, these override the global --read-structures for this sample, both for matching pattern construction and for output extraction.

Implementations

impl Sample

pub fn new(ordinal: usize, name: String, barcode: String) -> Self

Validates inputs to generate a Self struct and instantiates the struct if they are valid.

Panics

• Panics if sample name is empty string.
• Panics if barcode is empty string.
• Panics if barcode has bases other than A, C, G, T, U, R, Y, S, W, K, M, D, V, H, B, or N/n/.

pub fn with_read_structures( ordinal: usize, name: String, barcode: String, read_structures: Option<Vec<ReadStructure>>, ) -> Self

Like Sample::new but allows attaching per-sample read structures.

pub fn deserialize_header_line() -> String

Returns the header line expected by the metadata file deserializer. Only the two required columns are reported; per-sample read_structure_<n> columns are optional.

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sample

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

Formats the value using the given formatter.

impl Display for Sample

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

Implements a nice format display for the Sample struct. E.g. A sample with ordinal 2, name test-sample, and barcode GATTACA would look like: Sample(0002) - { name: test-sample barcode: GATTACA }

impl PartialEq for Sample

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Sample