Struct noodles_vcf::header::record::value::map::Map

pub struct Map<I>where
    I: Inner,{ /* private fields */ }

A VCF header map value.

Implementations

impl Map<AlternativeAllele>

pub fn new<D>(id: Symbol, description: D) -> Selfwhere
    D: Into<String>,

Creates a VCF header alternative allele map value.

Examples

use noodles_vcf::{
    header::record::value::{map::AlternativeAllele, Map},
    record::alternate_bases::allele::{
        symbol::{structural_variant::Type, StructuralVariant},
        Symbol,
    },
};

let map = Map::<AlternativeAllele>::new(
    Symbol::StructuralVariant(StructuralVariant::from(Type::Deletion)),
    "Deletion",
);

impl Map<Contig>

pub fn new(id: Name) -> Self

Creates a VCF header contig map value.

Examples

use noodles_vcf::header::record::value::{map::Contig, Map};
let map = Map::<Contig>::new("sq0".parse()?);

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

Returns the length.

Examples

use noodles_vcf::header::record::value::{map::Contig, Map};
let map = Map::<Contig>::new("sq0".parse()?);
assert!(map.length().is_none());

pub fn length_mut(&mut self) -> &mut Option<usize>

Returns a mutable reference to the length.

Examples

use noodles_vcf::header::record::value::{map::Contig, Map};

let mut map = Map::<Contig>::new("sq0".parse()?);
assert!(map.length().is_none());

*map.length_mut() = Some(8);
assert_eq!(map.length(), Some(8));

impl Map<Filter>

pub fn pass() -> Self

Creates a default VCF header filter map value for “PASS”.

Examples

use noodles_vcf::header::record::value::{map::Filter, Map};
let actual = Map::<Filter>::pass();
let expected = Map::<Filter>::new("PASS", "All filters passed");
assert_eq!(actual, expected);

pub fn new<S, T>(id: S, description: T) -> Selfwhere
    S: Into<String>,
    T: Into<String>,

Creates a VCF header filter map value.

Examples

use noodles_vcf::header::record::value::{map::Filter, Map};
let map = Map::<Filter>::new("q10", "Quality below 10");

impl Map<Format>

pub fn new<D>(id: Key, number: Number, ty: Type, description: D) -> Selfwhere
    D: Into<String>,

Creates a VCF header format map value.

Examples

use noodles_vcf::header::{
    format::{Key, Type},
    record::value::{map::Format, Map},
    Number,
};

let map = Map::<Format>::new(Key::Genotype, Number::Count(1), Type::String, "Genotype");

impl Map<Info>

pub fn new<D>(id: Key, number: Number, ty: Type, description: D) -> Selfwhere
    D: Into<String>,

Creates a VCF header info map value.

Examples

use noodles_vcf::header::{
    info::{Key, Type},
    record::value::{map::Info, Map},
    Number,
};

let map = Map::<Info>::new(
    Key::SamplesWithDataCount,
    Number::Count(1),
    Type::Integer,
    "Number of samples with data",
);

impl Map<Meta>

pub fn new<I>(id: I, values: Vec<String>) -> Selfwhere
    I: Into<String>,

Creates a VCF header meta map value.

Examples

use noodles_vcf::header::record::value::{map::Meta, Map};

let map = Map::<Meta>::new(
    "Assay",
    vec![String::from("WholeGenome"), String::from("Exome")],
);

pub fn values(&self) -> &[String]

Returns the meta values.

Examples

use noodles_vcf::header::record::value::{map::Meta, Map};
let values = vec![String::from("WholeGenome"), String::from("Exome")];
let map = Map::<Meta>::new("Assay", values.clone());
assert_eq!(map.values(), &values);

impl Map<Other>

pub fn new<I>(id: I) -> Selfwhere
    I: Into<String>,

Creates a nonstandard VCF header map value.

Examples

use noodles_vcf::header::record::value::{map::Other, Map};
let map = Map::<Other>::new("noodles");

impl<I> Map<I>where
    I: Inner,

pub fn builder() -> Builder<I>

Creates a VCF header map value builder.

pub fn id(&self) -> &I::Id

Returns the ID.

pub fn id_mut(&mut self) -> &mut I::Id

Returns a mutable reference to the ID.

pub fn other_fields(&self) -> &IndexMap<Other<I::StandardTag>, String>

Returns the nonstandard fields in the map.

impl<I> Map<I>where
    I: Typed,

pub fn number(&self) -> Number

Returns the cardinality of the field value.

pub fn number_mut(&mut self) -> &mut Number

Returns a mutable reference to the number.

pub fn ty(&self) -> I::Type

Returns the type of the field value.

pub fn type_mut(&mut self) -> &mut I::Type

Returns a mutable reference to the type.

impl<I> Map<I>where
    I: Described,

pub fn description(&self) -> &str

Returns the description.

pub fn description_mut(&mut self) -> &mut String

Returns a mutable reference to the description.

impl<I> Map<I>where
    I: Indexed,

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

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

pub fn idx_mut(&mut self) -> &mut Option<usize>

Returns a mutable reference to the index.

Trait Implementations

impl<I: Clone> Clone for Map<I>where
    I: Inner,
    I::Id: Clone,
    I::StandardTag: Clone,

fn clone(&self) -> Map<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for Map<I>where
    I: Inner,
    I::Id: Debug,
    I::StandardTag: Debug,

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

Formats the value using the given formatter.

impl Display for Map<AlternativeAllele>

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

Formats the value using the given formatter.

impl Display for Map<Contig>

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

Formats the value using the given formatter.

impl Display for Map<Filter>

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

Formats the value using the given formatter.

impl Display for Map<Format>

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

Formats the value using the given formatter.

impl Display for Map<Info>

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

Formats the value using the given formatter.

impl Display for Map<Meta>

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

Formats the value using the given formatter.

impl Display for Map<Other>

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

Formats the value using the given formatter.

impl From<Key> for Map<Format>

fn from(key: Key) -> Self

Converts to this type from the input type.

impl From<Key> for Map<Info>

fn from(key: Key) -> Self

Converts to this type from the input type.

impl From<Map<Other>> for Other

fn from(map: Map<Other>) -> Self

Converts to this type from the input type.

impl<I: PartialEq> PartialEq<Map<I>> for Map<I>where
    I: Inner,
    I::Id: PartialEq,
    I::StandardTag: PartialEq,

fn eq(&self, other: &Map<I>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<(FileFormat, Vec<(String, String), Global>)> for Map<Format>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(
    (file_format, fields): (FileFormat, Vec<(String, String)>)
) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(FileFormat, Vec<(String, String), Global>)> for Map<Info>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(
    (file_format, fields): (FileFormat, Vec<(String, String)>)
) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<AlternativeAllele>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<Contig>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<Filter>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<Format>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<Info>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<Meta>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<(String, String), Global>> for Map<Other>

type Error = TryFromFieldsError

The type returned in the event of a conversion error.

fn try_from(fields: Vec<(String, String)>) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Eq> Eq for Map<I>where
    I: Inner,
    I::Id: Eq,
    I::StandardTag: Eq,

impl<I> StructuralEq for Map<I>where
    I: Inner,

impl<I> StructuralPartialEq for Map<I>where
    I: Inner,