Struct noodles_vcf::header::string_maps::StringMap

pub struct StringMap { /* private fields */ }

An indexed map of VCF strings.

This is also called a dictionary of strings.

See § 6.2.1 Dictionary of strings (2021-05-13).

Implementations

impl StringMap

pub fn get_index(&self, i: usize) -> Option<&str>

Returns an entry by index.

Examples

use noodles_vcf::header::string_maps::StringMap;
let string_map = StringMap::default();
assert!(string_map.get_index(0).is_none());

pub fn get_index_of(&self, value: &str) -> Option<usize>

Returns the index of the entry of the given value.

Examples

use noodles_vcf::header::string_maps::StringMap;
let string_map = StringMap::default();
assert!(string_map.get_index_of("PASS").is_none());

Trait Implementations

impl Clone for StringMap

fn clone(&self) -> StringMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StringMap

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

Formats the value using the given formatter.

impl Default for StringMap

fn default() -> StringMap

Returns the “default value” for a type.

impl PartialEq for StringMap

fn eq(&self, other: &StringMap) -> 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 Eq for StringMap

impl StructuralPartialEq for StringMap