Struct noodles_vcf::record::info::field::Field

pub struct Field { /* private fields */ }

A VCF record info field.

Implementations

impl Field

pub fn try_from_str(s: &str, infos: &Infos) -> Result<Self, ParseError>

Parses a raw VCF record info field.

pub fn new(key: Key, value: Option<Value>) -> Self

Creates a VCF record info field.

Examples

use noodles_vcf::{
    header::info::Key,
    record::info::{field::Value, Field},
};

let field = Field::new(Key::SamplesWithDataCount, Some(Value::Integer(1)));

pub fn key(&self) -> &Key

Returns the field key.

Examples

use noodles_vcf::{
    header::info::Key,
    record::info::{field::Value, Field},
};

let field = Field::new(Key::SamplesWithDataCount, Some(Value::Integer(1)));
assert_eq!(field.key(), &Key::SamplesWithDataCount);

pub fn value(&self) -> Option<&Value>

Returns the field value.

Examples

use noodles_vcf::{
    header::info::Key,
    record::info::{field::Value, Field},
};

let field = Field::new(Key::SamplesWithDataCount, Some(Value::Integer(1)));
assert_eq!(field.value(), Some(&Value::Integer(1)));

pub fn value_mut(&mut self) -> &mut Option<Value>

Returns a mutable reference to the value.

Examples

use noodles_vcf::{
    header::info::Key,
    record::info::{field::Value, Field},
};

let mut field = Field::new(Key::SamplesWithDataCount, Some(Value::Integer(1)));
*field.value_mut() = Some(Value::Integer(2));
assert_eq!(field.value(), Some(&Value::Integer(2)));

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Display for Field

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

Formats the value using the given formatter.

impl FromStr for Field

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<Field> for Field

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