noodles_vcf::record::samples

Struct Samples

Source
pub struct Samples<'r>(/* private fields */);
Expand description

Raw VCF record genotypes.

Implementations§

Source§

impl<'r> Samples<'r>

Source

pub fn is_empty(&self) -> bool

Returns whether there may be any genotypes.

Source

pub fn keys(&self) -> Keys<'r>

Returns the keys.

Source

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

Returns the sample with the given sample name.

Source

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

Returns the sample at the given index.

Source

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

Returns the series with the given column name.

Source

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

Returns an iterator over series.

Source

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

Returns an iterator over samples.

Trait Implementations§

Source§

impl<'a> AsRef<str> for Samples<'a>

Source§

fn as_ref(&self) -> &str

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

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

Source§

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

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

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

Source§

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

Source§

fn is_empty(&self) -> bool

Returns whether there are any samples.
Source§

fn len(&self) -> usize

Returns the number of samples.
Source§

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

Returns the column names.
Source§

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

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

Returns an iterator over series.
Source§

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

Returns an iterator over samples.
Source§

impl<'r> Eq for Samples<'r>

Source§

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

Auto Trait Implementations§

§

impl<'r> Freeze for Samples<'r>

§

impl<'r> RefUnwindSafe for Samples<'r>

§

impl<'r> Send for Samples<'r>

§

impl<'r> Sync for Samples<'r>

§

impl<'r> Unpin for Samples<'r>

§

impl<'r> UnwindSafe for Samples<'r>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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, 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.