Struct noodles::vcf::header::Contig

pub struct Contig { /* fields omitted */ }

A VCF header contig record (contig).

Implementations

impl Contig

pub fn new<S>(id: S) -> Contig where
    S: Into<String>, 

Creates a VCF header contig record.

Examples

use noodles_vcf::header::Contig;
let contig = Contig::new("sq0");

pub fn id(&self) -> &str

Returns the ID of the contig.

Examples

use noodles_vcf::header::Contig;
let contig = Contig::new("sq0");
assert_eq!(contig.id(), "sq0");

pub fn len(&self) -> Option<i32>

Returns the length of the contig, if it is set.

Examples

use noodles_vcf::header::Contig;
let contig = Contig::new("sq0");
assert_eq!(contig.len(), None);

pub fn get(&self, key: &str) -> Option<&str>

Returns the value of the field with the given key.

Examples

use std::convert::TryFrom;
use noodles_vcf::header::{contig, record, Record, Contig};

let record = Record::new(
    record::Key::Contig,
    record::Value::Struct(vec![
        (String::from("ID"), String::from("sq0")),
        (String::from("md5"), String::from("d7eba311421bbc9d3ada44709dd61534")),
    ]),
);
let contig = Contig::try_from(record)?;

assert_eq!(contig.get("md5"), Some("d7eba311421bbc9d3ada44709dd61534"));
assert!(contig.get("species").is_none());

Trait Implementations

impl Clone for Contig

pub fn clone(&self) -> Contig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Contig

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

Formats the value using the given formatter.

impl Display for Contig

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

Formats the value using the given formatter.

impl PartialEq<Contig> for Contig

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

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

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

This method tests for !=.

impl TryFrom<Record> for Contig

type Error = TryFromRecordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Contig

impl StructuralEq for Contig

impl StructuralPartialEq for Contig