Struct noodles_vcf::header::contig::Contig

source · [−]

pub struct Contig { /* private fields */ }

Expand description

A VCF header contig record (contig).

Implementations

impl Contig

pub fn new<S>(id: S) -> Self 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 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::Contig;
let contig = Contig::new("sq0");
assert!(contig.idx().is_none());

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

Returns the value of the field with the given key.

Examples

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

fn clone(&self) -> Contig

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Contig

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

Formats the value using the given formatter. Read more

impl Display for Contig

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

Formats the value using the given formatter. Read more

impl PartialEq<Contig> for Contig

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

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

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.

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

Performs the conversion.

impl Eq for Contig

impl StructuralEq for Contig

impl StructuralPartialEq for Contig

Auto Trait Implementations

impl RefUnwindSafe for Contig

impl Send for Contig

impl Sync for Contig

impl Unpin for Contig

impl UnwindSafe for Contig

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more