Struct noodles_vcf::header::info::Info

source · [−]

pub struct Info { /* private fields */ }

Expand description

A VCF header information record (INFO).

Implementations

source

impl Info

source

pub fn try_from_record_file_format(
record: Record,
file_format: FileFormat
) -> Result<Self, TryFromRecordError>

Converts a generic VCF header record to a VCF header info record.

Examples

use noodles_vcf::{
    header::{info::Type, record::{Key, Value}, FileFormat, Info, Number, Record},
    record::info,
};

let record = Record::new(
    Key::Info,
    Value::Struct(vec![
        (String::from("ID"), String::from("NS")),
        (String::from("Number"), String::from("1")),
        (String::from("Type"), String::from("Integer")),
        (
            String::from("Description"),
            String::from("Number of samples with data"),
        ),
    ]),
);

assert_eq!(
    Info::try_from_record_file_format(record, FileFormat::new(4, 3)),
    Ok(Info::new(
        info::field::Key::SamplesWithDataCount,
        Number::Count(1),
        Type::Integer,
        String::from("Number of samples with data"),
    ))
);

source

pub fn new(id: Key, number: Number, ty: Type, description: String) -> Self

Creates a VCF header information record.

Examples

use noodles_vcf::{
    header::{info::Type, Info, Number},
    record::info::field::Key,
};

let info = Info::new(
    Key::SamplesWithDataCount,
    Number::Count(1),
    Type::Integer,
    String::from("Number of samples with data"),
);

source

pub fn id(&self) -> &Key

Returns the information field key.

Examples

use noodles_vcf::{header::Info, record::info::field::Key};
let info = Info::from(Key::SamplesWithDataCount);
assert_eq!(info.id(), &Key::SamplesWithDataCount);

source

pub fn number(&self) -> Number

Returns the cardinality of the information field value.

Examples

use noodles_vcf::{header::{Info, Number}, record::info::field::Key};
let info = Info::from(Key::SamplesWithDataCount);
assert_eq!(info.number(), Number::Count(1));

source

pub fn ty(&self) -> Type

Returns the type of the information field value.

Examples

use noodles_vcf::{header::{info::Type, Info}, record::info::field::Key};
let info = Info::from(Key::SamplesWithDataCount);
assert_eq!(info.ty(), Type::Integer);

source

pub fn description(&self) -> &str

Returns the description of the information field.

Examples

use noodles_vcf::{header::Info, record::info::field::Key};
let info = Info::from(Key::SamplesWithDataCount);
assert_eq!(info.description(), "Number of samples with data");

source

pub fn idx(&self) -> Option<usize>

Returns the index of the ID in the dictionary of strings.

This is typically used in BCF.

Examples

use noodles_vcf::{header::Info, record::info::field::Key};
let info = Info::from(Key::SamplesWithDataCount);
assert!(info.idx().is_none());

source

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

Returns the extra fields in the record.

This includes fields other than ID, Number, Type, Description, and IDX.

Examples

use noodles_vcf::{header::Info, record::info::field::Key};
let info = Info::from(Key::SamplesWithDataCount);
assert!(info.fields().is_empty());

Trait Implementations

source

impl Clone for Info

source

fn clone(&self) -> Info

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 Info

source

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

Formats the value using the given formatter. Read more

source

impl Display for Info

source

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

Formats the value using the given formatter. Read more

source

impl From<Key> for Info

source

fn from(key: Key) -> Self

Performs the conversion.

source

impl PartialEq<Info> for Info

source

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

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

source

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

This method tests for !=.

source

impl TryFrom<Record> for Info

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 Info

source

impl StructuralEq for Info

source

impl StructuralPartialEq for Info

Auto Trait Implementations

impl RefUnwindSafe for Info

impl Send for Info

impl Sync for Info

impl Unpin for Info

impl UnwindSafe for Info

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::info::Info

Implementations

impl Info

pub fn try_from_record_file_format( record: Record, file_format: FileFormat) -> Result<Self, TryFromRecordError>

pub fn new(id: Key, number: Number, ty: Type, description: String) -> Self

pub fn id(&self) -> &Key

pub fn number(&self) -> Number

pub fn ty(&self) -> Type

pub fn description(&self) -> &str

pub fn idx(&self) -> Option<usize>

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

Trait Implementations

impl Clone for Info

fn clone(&self) -> Info

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

impl Debug for Info

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

impl Display for Info

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

impl From<Key> for Info

fn from(key: Key) -> Self

impl PartialEq<Info> for Info

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

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

impl TryFrom<Record> for Info

type Error = TryFromRecordError

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

impl Eq for Info

impl StructuralEq for Info

impl StructuralPartialEq for Info

Auto Trait Implementations

impl RefUnwindSafe for Info

impl Send for Info

impl Sync for Info

impl Unpin for Info

impl UnwindSafe for Info

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>

pub fn try_from_record_file_format(
record: Record,
file_format: FileFormat
) -> Result<Self, TryFromRecordError>

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>,