Struct noodles_vcf::variant::record_buf::builder::Builder

pub struct Builder { /* private fields */ }

A VCF record builder.

Implementations

impl Builder

pub fn set_reference_sequence_name<N>(self, reference_sequence_name: N) -> Self

where N: Into<String>,

Sets the reference sequence name.

Examples

use noodles_vcf as vcf;

let record = vcf::variant::RecordBuf::builder()
    .set_reference_sequence_name("sq0")
    .build();

assert_eq!(record.reference_sequence_name(), "sq0");

pub fn set_variant_start(self, position: Position) -> Self

Sets the variant start position.

Examples

use noodles_core::Position;
use noodles_vcf as vcf;

let record = vcf::variant::RecordBuf::builder()
    .set_variant_start(Position::MIN)
    .build();

assert_eq!(record.variant_start(), Some(Position::MIN));

pub fn set_ids(self, ids: Ids) -> Self

Sets a list of IDs.

Examples

use noodles_vcf::{self as vcf, variant::record_buf::Ids};

let ids: Ids = [String::from("nd0")].into_iter().collect();

let record = vcf::variant::RecordBuf::builder()
    .set_ids(ids.clone())
    .build();

assert_eq!(record.ids(), &ids);

pub fn set_reference_bases<B>(self, reference_bases: B) -> Self

where B: Into<String>,

Sets the reference bases.

Examples

use noodles_vcf as vcf;

let record = vcf::variant::RecordBuf::builder()
    .set_reference_bases("A")
    .build();

assert_eq!(record.reference_bases(), "A");

pub fn set_alternate_bases(self, alternate_bases: AlternateBases) -> Self

Sets the alternate bases.

Examples

use noodles_vcf::{self as vcf, variant::record_buf::AlternateBases};

let alternate_bases = AlternateBases::from(vec![String::from("C")]);

let record = vcf::variant::RecordBuf::builder()
    .set_alternate_bases(alternate_bases.clone())
    .build();

assert_eq!(record.alternate_bases(), &alternate_bases);

pub fn set_quality_score(self, quality_score: f32) -> Self

Sets the quality score.

Examples

use noodles_vcf as vcf;

let record = vcf::variant::RecordBuf::builder()
    .set_quality_score(13.0)
    .build();

assert_eq!(record.quality_score(), Some(13.0));

pub fn set_filters(self, filters: Filters) -> Self

Sets the filters.

Examples

use noodles_vcf::{self as vcf, variant::record_buf::Filters};

let record = vcf::variant::RecordBuf::builder()
    .set_filters(Filters::pass())
    .build();

assert!(record.filters().is_pass());

pub fn set_info(self, info: Info) -> Self

Sets additional information.

Examples

use noodles_vcf::{
    self as vcf,
    variant::{
        record::info::field::key,
        record_buf::{info::field::Value, Info},
    },
};

let info: Info = [
    (String::from(key::SAMPLES_WITH_DATA_COUNT), Some(Value::Integer(3))),
    (String::from(key::ALLELE_FREQUENCIES), Some(Value::from(vec![Some(0.5)]))),
]
.into_iter()
.collect();

let record = vcf::variant::RecordBuf::builder()
    .set_info(info.clone())
    .build();

assert_eq!(record.info(), &info);

pub fn set_samples(self, samples: Samples) -> Self

Sets the list of genotypes.

Examples

use noodles_vcf::{
    self as vcf,
    variant::{
        record::samples::keys::key,
        record_buf::{samples::{sample::Value, Keys}, Samples},
    },
};

let keys: Keys = [
    String::from(key::GENOTYPE),
    String::from(key::CONDITIONAL_GENOTYPE_QUALITY),
].into_iter().collect();

let samples = Samples::new(
    keys,
    vec![vec![Some(Value::from("0|0")), Some(Value::from(13))]],
);

let record = vcf::variant::RecordBuf::builder()
    .set_samples(samples.clone())
    .build();

assert_eq!(record.samples(), &samples);

pub fn build(self) -> RecordBuf

Builds a VCF record.

Examples

use noodles_vcf as vcf;
let record = vcf::variant::RecordBuf::builder().build();

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Builder

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