Struct noodles_vcf::header::format::Format

source · [−]

pub struct Format { /* private fields */ }

Expand description

A VCF header genotype format record (FORMAT).

Implementations

source

impl Format

source

pub fn try_from_record_file_format(
record: Record,
file_format: FileFormat
) -> Result<Self, TryFromRecordError>

Converts a generic VCF header record to a VCF header format record.

Examples

use noodles_vcf::header::{
    format::{Key as FormatKey, Type},
    record::{Key as RecordKey, Value},
    FileFormat, Format, Number, Record,
};

let record = Record::new(
    RecordKey::Format,
    Value::Struct(vec![
        (String::from("ID"), String::from("GT")),
        (String::from("Number"), String::from("1")),
        (String::from("Type"), String::from("String")),
        (String::from("Description"), String::from("Genotype")),
    ]),
);

assert_eq!(
    Format::try_from_record_file_format(record, FileFormat::new(4, 3)),
    Ok(Format::new(
        FormatKey::Genotype,
        Number::Count(1),
        Type::String,
        String::from("Genotype"),
    ))
);

source

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

Creates a VCF header genotype format record.

Examples

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

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

source

pub fn id(&self) -> &Key

Returns the genotype field key.

Examples

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

source

pub fn number(&self) -> Number

Returns the cardinality of the genotype field value.

Examples

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

source

pub fn ty(&self) -> Type

Returns the type of the genotype field value.

Examples

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

source

pub fn description(&self) -> &str

Returns the description of the genotype field.

Examples

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

source

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

source

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

Returns the extra fields in the record.

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

Examples

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

Trait Implementations

source

impl Clone for Format

source

fn clone(&self) -> Format

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

source

impl Debug for Format

source

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

Formats the value using the given formatter. Read more

source

impl Display for Format

source

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

Formats the value using the given formatter. Read more

source

impl From<Key> for Format

source

fn from(key: Key) -> Self

Converts to this type from the input type.

source

impl PartialEq<Format> for Format

source

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

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

source

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

This method tests for !=.

source

impl TryFrom<Record> for Format

type Error = TryFromRecordError

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl Eq for Format

source

impl StructuralEq for Format

source

impl StructuralPartialEq for Format

Auto Trait Implementations

impl RefUnwindSafe for Format

impl Send for Format

impl Sync for Format

impl Unpin for Format

impl UnwindSafe for Format

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

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

source

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

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

impl<T, U> Into 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.

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

source

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

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct noodles_vcf::header::format::Format

Implementations

impl Format

pub fn try_from_record_file_format( record: Record, file_format: FileFormat) -> Result<Self, TryFromRecordError>

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

pub fn id(&self) -> &Key

pub fn number(&self) -> Number

pub fn ty(&self) -> Type

pub fn description(&self) -> &str

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

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

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

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

impl Debug for Format

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

impl Display for Format

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

impl From<Key> for Format

fn from(key: Key) -> Self

impl PartialEq<Format> for Format

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

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

impl TryFrom<Record> for Format

type Error = TryFromRecordError

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

impl Eq for Format

impl StructuralEq for Format

impl StructuralPartialEq for Format

Auto Trait Implementations

impl RefUnwindSafe for Format

impl Send for Format

impl Sync for Format

impl Unpin for Format

impl UnwindSafe for Format

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn try_from_record_file_format(
record: Record,
file_format: FileFormat
) -> Result<Self, TryFromRecordError>

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

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

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

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

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

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

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

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

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

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