Struct noodles_bcf::record::samples::Samples

pub struct Samples<'r> { /* private fields */ }

BCF record genotypes.

Implementations

impl<'r> Samples<'r>

pub fn format_count(&self) -> usize

Returns the number of fields per sample.

Examples

use noodles_bcf::record::Samples;
let samples = Samples::default();
assert_eq!(samples.format_count(), 0);

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

Returns the sample with the given sample name.

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

Returns a sample at the given index.

pub fn select<'h: 'r>( &'r self, header: &'h Header, column_name: &str, ) -> Option<Result<Series<'r>>>

Returns the series with the given column name.

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

Returns an iterator over series.

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

Returns an iterator over samples.

Trait Implementations

impl<'r> AsRef<[u8]> for Samples<'r>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'r> Clone for Samples<'r>

fn clone(&self) -> Samples<'r>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r> Debug for Samples<'r>

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

Formats the value using the given formatter.

impl<'r> Default for Samples<'r>

fn default() -> Samples<'r>

Returns the “default value” for a type.

impl<'r> PartialEq for Samples<'r>

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

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, header: &'h Header, ) -> Box<dyn Iterator<Item = Result<&'a str>> + 'a>

Returns the column names.

fn select<'a, 'h: 'a>( &'a self, header: &'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<'r> Eq for Samples<'r>

impl<'r> StructuralPartialEq for Samples<'r>