Struct noodles_vcf::variant::record_buf::samples::Samples

pub struct Samples { /* private fields */ }

A variant record samples buffer.

Implementations

impl Samples

pub fn new(keys: Keys, values: Vec<Vec<Option<Value>>>) -> Self

Creates a variant record samples buffer.

Examples

use noodles_vcf::variant::record_buf::{samples::Keys, Samples};
let genotypes = Samples::new(Keys::default(), Vec::new());

pub fn is_empty(&self) -> bool

Returns whether there are any samples.

Examples

use noodles_vcf::variant::record_buf::Samples;
let samples = Samples::default();
assert!(samples.is_empty());

pub fn keys(&self) -> &Keys

Returns the keys.

Examples

use noodles_vcf::variant::{
    record::samples::keys::key,
    record_buf::{samples::Keys, Samples},
};

let samples = Samples::default();
assert!(samples.keys().as_ref().is_empty());

let keys: Keys = [String::from(key::GENOTYPE)].into_iter().collect();
let samples = Samples::new(keys.clone(), Vec::new());
assert_eq!(samples.keys(), &keys);

pub fn keys_mut(&mut self) -> &mut Keys

Returns a mutable reference to the keys.

Examples

use noodles_vcf::variant::{
    record::samples::keys::key,
    record_buf::{samples::Keys, Samples},
};

let keys: Keys = [String::from(key::GENOTYPE)].into_iter().collect();

let mut samples = Samples::default();
*samples.keys_mut() = keys.clone();

assert_eq!(samples.keys(), &keys);

pub fn values(&self) -> impl Iterator<Item = Sample<'_>>

Returns samples.

pub fn get(&self, header: &Header, sample_name: &str) -> Option<Sample<'_>>

Returns the sample with the given sample name.

Examples

use noodles_vcf::{
    self as vcf,
    variant::{
        record::samples::keys::key,
        record_buf::{samples::sample::Value, Samples},
    },
};

let header = vcf::Header::builder()
    .add_sample_name("sample0")
    .add_sample_name("sample1")
    .add_sample_name("sample2")
    .build();

let keys = [String::from(key::GENOTYPE)].into_iter().collect();
let samples = Samples::new(
    keys,
    vec![
        vec![Some(Value::from("0|0"))],
        vec![Some(Value::from("1/1"))],
        vec![],
    ],
);

let sample = samples.get(&header, "sample0");
assert_eq!(sample.and_then(|s| s.values().get(0)), Some(&Some(Value::from("0|0"))));

pub fn get_index(&self, i: usize) -> Option<Sample<'_>>

Returns the sample at the given index.

pub fn select(&self, name: &str) -> Option<Series<'_>>

Returns the series with the given column name.

Examples

use noodles_vcf::variant::{
    record::samples::keys::key,
    record_buf::{samples::sample::Value, Samples},
};

let keys = [String::from(key::GENOTYPE)].into_iter().collect();
let samples = Samples::new(
    keys,
    vec![
        vec![Some(Value::from("0|0"))],
        vec![Some(Value::from("1/1"))],
        vec![],
    ],
);

let series = samples.select(key::GENOTYPE).expect("missing genotype column");
assert_eq!(series.get(0), Some(Some(&Value::from("0|0"))));
assert_eq!(series.get(1), Some(Some(&Value::from("1/1"))));
assert_eq!(series.get(2), Some(None));
assert_eq!(series.get(3), None);

pub fn series(&self) -> impl Iterator<Item = Series<'_>>

Returns an iterator over series.

Trait Implementations

impl Clone for Samples

fn clone(&self) -> Samples

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Samples

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

Formats the value using the given formatter.

impl Default for Samples

fn default() -> Samples

Returns the “default value” for a type.

impl From<Samples> for (Keys, Vec<Vec<Option<Value>>>)

fn from(samples: Samples) -> Self

Converts to this type from the input type.

impl PartialEq for Samples

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

fn is_empty(&self) -> bool

Returns whether there are any samples.

fn len(&self) -> usize

Returns the number of samples.

fn column_names<'a, 'h: 'a>( &'a self, _: &'h Header, ) -> Box<dyn Iterator<Item = Result<&'a str>> + 'a>

Returns the column names.

fn select<'a, 'h: 'a>( &'a self, _: &'h Header, column_name: &str, ) -> Option<Result<Box<dyn Series + 'a>>>

Returns the series with the given column name.

fn series(&self) -> Box<dyn Iterator<Item = Result<Box<dyn Series + '_>>> + '_>

Returns an iterator over series.

fn iter(&self) -> Box<dyn Iterator<Item = Box<dyn Sample + '_>> + '_>

Returns an iterator over samples.

impl Samples for Samples

fn is_empty(&self) -> bool

Returns whether there are any samples.

fn len(&self) -> usize

Returns the number of samples.

fn column_names<'a, 'h: 'a>( &'a self, _: &'h Header, ) -> Box<dyn Iterator<Item = Result<&'a str>> + 'a>

Returns the column names.

fn select<'a, 'h: 'a>( &'a self, _: &'h Header, column_name: &str, ) -> Option<Result<Box<dyn Series + 'a>>>

Returns the series with the given column name.

fn series(&self) -> Box<dyn Iterator<Item = Result<Box<dyn Series + '_>>> + '_>

Returns an iterator over series.

fn iter(&self) -> Box<dyn Iterator<Item = Box<dyn Sample + '_>> + '_>

Returns an iterator over samples.

impl StructuralPartialEq for Samples