1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
//! VCF record builder.
use noodles_core::Position;
use super::{AlternateBases, Filters, Ids, Info, RecordBuf, Samples};
/// A VCF record builder.
#[derive(Debug, PartialEq)]
pub struct Builder {
reference_sequence_name: String,
variant_start: Option<Position>,
ids: Ids,
reference_bases: String,
alternate_bases: AlternateBases,
quality_score: Option<f32>,
filters: Filters,
info: Info,
samples: Samples,
}
impl Builder {
/// 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_reference_sequence_name<N>(mut self, reference_sequence_name: N) -> Self
where
N: Into<String>,
{
self.reference_sequence_name = reference_sequence_name.into();
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_variant_start(mut self, position: Position) -> Self {
self.variant_start = Some(position);
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_ids(mut self, ids: Ids) -> Self {
self.ids = ids;
self
}
/// 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_reference_bases<B>(mut self, reference_bases: B) -> Self
where
B: Into<String>,
{
self.reference_bases = reference_bases.into();
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_alternate_bases(mut self, alternate_bases: AlternateBases) -> Self {
self.alternate_bases = alternate_bases;
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_quality_score(mut self, quality_score: f32) -> Self {
self.quality_score = Some(quality_score);
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_filters(mut self, filters: Filters) -> Self {
self.filters = filters;
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_info(mut self, info: Info) -> Self {
self.info = info;
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 set_samples(mut self, samples: Samples) -> Self {
self.samples = samples;
self
}
/// Builds a VCF record.
///
/// # Examples
///
/// ```
/// use noodles_vcf as vcf;
/// let record = vcf::variant::RecordBuf::builder().build();
/// ```
pub fn build(self) -> RecordBuf {
RecordBuf {
reference_sequence_name: self.reference_sequence_name,
variant_start: self.variant_start,
ids: self.ids,
reference_bases: self.reference_bases,
alternate_bases: self.alternate_bases,
quality_score: self.quality_score,
filters: self.filters,
info: self.info,
samples: self.samples,
}
}
}
impl Default for Builder {
fn default() -> Self {
Self {
reference_sequence_name: String::new(),
variant_start: Some(Position::MIN),
ids: Ids::default(),
reference_bases: String::new(),
alternate_bases: AlternateBases::default(),
quality_score: None,
filters: Filters::default(),
info: Info::default(),
samples: Samples::default(),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::variant::record::AlternateBases as _;
#[test]
fn test_default() {
let record = Builder::default();
assert!(record.reference_sequence_name.is_empty());
assert_eq!(record.variant_start, Some(Position::MIN));
assert!(record.ids.as_ref().is_empty());
assert!(record.reference_bases.is_empty());
assert!(record.alternate_bases.is_empty());
assert!(record.quality_score.is_none());
assert!(record.filters.as_ref().is_empty());
assert!(record.info.as_ref().is_empty());
assert!(record.samples.is_empty());
}
}