Struct noodles_vcf::header::sample::Sample

source · [−]

pub struct Sample { /* private fields */ }

Expand description

A VCF header sample record (SAMPLE).

Implementations

source

impl Sample

source

pub fn new(id: String, fields: IndexMap<String, String>) -> Self

Creates a VCF header sample record.

Examples

use noodles_vcf::header::Sample;
let sample = Sample::new(String::from("sample0"), Default::default());

source

pub fn id(&self) -> &str

Returns the ID of the sample record.

Examples

use noodles_vcf::header::Sample;
let sample = Sample::new(String::from("sample0"), Default::default());
assert_eq!(sample.id(), "sample0");

source

pub fn fields(&self) -> &IndexMap<String, String>

Returns the extra fields in the record.

This includes fields other than ID.

Examples

use noodles_vcf::header::Sample;
let sample = Sample::new(String::from("sample0"), Default::default());
assert!(sample.fields().is_empty());

Trait Implementations

source

impl Clone for Sample

source

fn clone(&self) -> Sample

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Sample

source

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

Formats the value using the given formatter. Read more

source

impl Display for Sample

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<Sample> for Sample

source

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

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

source

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

This method tests for !=.

source

impl TryFrom<Record> for Sample

type Error = TryFromRecordError

The type returned in the event of a conversion error.

source

fn try_from(record: Record) -> Result<Self, Self::Error>

Performs the conversion.

source

impl Eq for Sample

source

impl StructuralEq for Sample

source

impl StructuralPartialEq for Sample

Auto Trait Implementations

impl RefUnwindSafe for Sample

impl Send for Sample

impl Sync for Sample

impl Unpin for Sample

impl UnwindSafe for Sample

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub 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

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

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct noodles_vcf::header::sample::Sample

Implementations

impl Sample

pub fn new(id: String, fields: IndexMap<String, String>) -> Self

pub fn id(&self) -> &str

pub fn fields(&self) -> &IndexMap<String, String>

Trait Implementations

impl Clone for Sample

fn clone(&self) -> Sample

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

impl Debug for Sample

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

impl Display for Sample

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

impl PartialEq<Sample> for Sample

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

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

impl TryFrom<Record> for Sample

type Error = TryFromRecordError

fn try_from(record: Record) -> Result<Self, Self::Error>

impl Eq for Sample

impl StructuralEq for Sample

impl StructuralPartialEq for Sample

Auto Trait Implementations

impl RefUnwindSafe for Sample

impl Send for Sample

impl Sync for Sample

impl Unpin for Sample

impl UnwindSafe for Sample

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,