Struct noodles::vcf::header::Format

pub struct Format { /* fields omitted */ }

A VCF header genotype format record (FORMAT).

Implementations

impl Format

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

Creates a VCF header genotype format record.

Examples

use noodles_vcf::{
    header::{format::Type, Format, Number},
    record::genotype::field::Key,
};

let format = Format::new(
    Key::Genotype,
    Number::Count(1),
    Type::String,
    String::from("Genotype"),
);

pub fn id(&self) -> &Key

Returns the genotype field key.

Examples

use noodles_vcf::{header::Format, record::genotype::field::Key};
let format = Format::from(Key::Genotype);
assert_eq!(format.id(), &Key::Genotype);

pub fn number(&self) -> Number

Returns the cardinality of the genotype field value.

Examples

use noodles_vcf::{header::{Format, Number}, record::genotype::field::Key};
let format = Format::from(Key::Genotype);
assert_eq!(format.number(), Number::Count(1));

pub fn ty(&self) -> Type

Returns the type of the genotype field value.

Examples

use noodles_vcf::{header::{format::Type, Format}, record::genotype::field::Key};
let format = Format::from(Key::Genotype);
assert_eq!(format.ty(), Type::String);

pub fn description(&self) -> &str

Returns the description of the genotype field.

Examples

use noodles_vcf::{header::Format, record::genotype::field::Key};
let format = Format::from(Key::Genotype);
assert_eq!(format.description(), "Genotype");

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::Format, record::genotype::field::Key};
let format = Format::from(Key::Genotype);
assert!(format.idx().is_none());

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

Returns the extra fields in the record.

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

Examples

use noodles_vcf::{header::Format, record::genotype::field::Key};
let format = Format::from(Key::Genotype);
assert!(format.fields().is_empty());

Trait Implementations

impl Clone for Format

pub fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Display for Format

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

Formats the value using the given formatter.

impl From<Key> for Format

pub fn from(key: Key) -> Format

Performs the conversion.

impl PartialEq<Format> for Format

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

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

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

This method tests for !=.

impl TryFrom<Record> for Format

type Error = TryFromRecordError

The type returned in the event of a conversion error.

pub fn try_from(
    record: Record
) -> Result<Format, <Format as TryFrom<Record>>::Error>

Performs the conversion.

impl Eq for Format

impl StructuralEq for Format

impl StructuralPartialEq for Format