Struct noodles_vcf::header::filter::Filter

pub struct Filter { /* private fields */ }

A VCF header filter record (FILTER).

Implementations

impl Filter

pub fn pass() -> Self

Creates a default filter record for PASS.

Examples

use noodles_vcf::header::Filter;
let filter = Filter::pass();
assert_eq!(filter, Filter::new("PASS", "All filters passed"));

pub fn new<S, T>(id: S, description: T) -> Self where
    S: Into<String>,
    T: Into<String>, 

Creates a VCF header filter record.

Examples

use noodles_vcf::header::Filter;
let filter = Filter::new("q10", "Quality below 10");

pub fn id(&self) -> &str

Returns the ID of the filter.

Examples

use noodles_vcf::header::Filter;
let filter = Filter::new("q10", "Quality below 10");
assert_eq!(filter.id(), "q10");

pub fn description(&self) -> &str

Returns the description of the filter.

Examples

use noodles_vcf::header::Filter;
let filter = Filter::new("q10", "Quality below 10");
assert_eq!(filter.description(), "Quality below 10");

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::Filter;
let filter = Filter::new("q10", "Quality below 10");
assert!(filter.idx().is_none());

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

Returns the extra fields in the record.

This includes fields other than ID and Description.

Examples

use noodles_vcf::header::Filter;
let filter = Filter::new("q10", "Quality below 10");
assert!(filter.fields().is_empty());

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Display for Filter

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

Formats the value using the given formatter.

impl PartialEq<Filter> for Filter

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

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

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

This method tests for !=.

impl TryFrom<Record> for Filter

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 Filter

impl StructuralEq for Filter

impl StructuralPartialEq for Filter