Struct fqtk_lib::samples::Sample

pub struct Sample {
    pub sample_id: String,
    pub barcode: String,
    /* 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

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, or T.

pub fn deserialize_header_line() -> String

Returns the header line expected by serde when deserializing

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

Returns a copy 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<'de> Deserialize<'de> for Sample

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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<Sample> for Sample

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

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

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.

impl Eq for Sample

impl StructuralEq for Sample

impl StructuralPartialEq for Sample