Struct noodles_vcf::header::info::Info

pub struct Info { /* private fields */ }

A VCF header information record (INFO).

Implementations

impl Info

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"),
    ))
);

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"),
);

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);

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));

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);

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");

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());

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

impl Clone for Info

fn clone(&self) -> Info

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Info

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

Formats the value using the given formatter.

impl Display for Info

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

Formats the value using the given formatter.

impl From<Key> for Info

fn from(key: Key) -> Self

Performs the conversion.

impl PartialEq<Info> for Info

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

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

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

This method tests for !=.

impl TryFrom<Record> for Info

type Error = TryFromRecordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Info

impl StructuralEq for Info

impl StructuralPartialEq for Info