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 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
//! BCF record.
mod alternate_bases;
pub(crate) mod codec;
mod fields;
mod filters;
mod ids;
mod info;
mod reference_bases;
pub mod samples;
mod value;
use std::{fmt, io, str};
use noodles_core::Position;
use noodles_vcf::{self as vcf, header::StringMaps};
use self::fields::Fields;
pub(crate) use self::value::Value;
pub use self::{
alternate_bases::AlternateBases, filters::Filters, ids::Ids, info::Info,
reference_bases::ReferenceBases, samples::Samples,
};
/// A BCF record.
#[derive(Clone, Default, PartialEq)]
pub struct Record(Fields);
impl Record {
pub(crate) fn fields_mut(&mut self) -> &mut Fields {
&mut self.0
}
/// Returns the reference sequence ID of the record.
///
/// The reference sequence ID represents an index in the contig string map, which associates an
/// ID (by position) with a contig record in the VCF header (by name). That is, to get the
/// associated contig record in the VCF header, the contig string map must first be queried by
/// position to find the chromosome name, and then the contigs in the VCF header can be queried
/// by name.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// let record = bcf::Record::default();
/// assert_eq!(record.reference_sequence_id()?, 0);
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn reference_sequence_id(&self) -> io::Result<usize> {
let n = self.0.reference_sequence_id();
usize::try_from(n).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}
/// Returns the reference sequence name.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_vcf::{
/// self as vcf,
/// header::{record::value::{map::Contig, Map}, StringMaps},
/// };
///
/// let header = vcf::Header::builder()
/// .add_contig("sq0", Map::<Contig>::new())
/// .build();
/// let string_maps = StringMaps::try_from(&header)?;
///
/// let record = bcf::Record::default();
/// assert_eq!(record.reference_sequence_name(&string_maps)?, "sq0");
/// # Ok::<_, Box<dyn std::error::Error>>(())
/// ```
pub fn reference_sequence_name<'h>(&self, string_maps: &'h StringMaps) -> io::Result<&'h str> {
self.reference_sequence_id().and_then(|i| {
string_maps.contigs().get_index(i).ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidData,
"missing reference sequence name in contig string map",
)
})
})
}
/// Returns the variant start position.
///
/// Despite the BCF format using 0-based positions, this normalizes the value as a 1-based
/// position.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_core::Position;
/// let record = bcf::Record::default();
/// assert_eq!(record.variant_start().transpose()?, Some(Position::MIN));
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn variant_start(&self) -> Option<io::Result<Position>> {
self.0.variant_start().map(|n| {
usize::try_from(n)
.map(|m| m + 1)
.and_then(Position::try_from)
.map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
})
}
pub(crate) fn rlen(&self) -> io::Result<usize> {
let n = self.0.span();
usize::try_from(n).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))
}
/// Returns the end position of this record.
///
/// This value is 1-based.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_core::Position;
/// let record = bcf::Record::default();
/// assert_eq!(record.end()?, Position::MIN);
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn end(&self) -> io::Result<Position> {
let Some(start) = self.variant_start().transpose()? else {
todo!();
};
let len = self.rlen()?;
start.checked_add(len - 1).ok_or_else(|| {
io::Error::new(
io::ErrorKind::InvalidData,
"calculation of the end position overflowed",
)
})
}
/// Returns the quality score.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// let record = bcf::Record::default();
/// assert!(record.quality_score()?.is_none());
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn quality_score(&self) -> io::Result<Option<f32>> {
self.0.quality_score()
}
/// Returns the IDs.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_vcf::variant::record::Ids;
/// let record = bcf::Record::default();
/// assert!(record.ids().is_empty());
/// ```
pub fn ids(&self) -> Ids<'_> {
self.0.ids()
}
/// Returns the reference bases.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// let record = bcf::Record::default();
/// assert_eq!(record.reference_bases().as_ref(), b"N");
/// ```
pub fn reference_bases(&self) -> ReferenceBases<'_> {
self.0.reference_bases()
}
/// Returns the alternate bases.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_vcf::variant::record::AlternateBases;
/// let record = bcf::Record::default();
/// assert!(record.alternate_bases().is_empty());
/// ```
pub fn alternate_bases(&self) -> AlternateBases<'_> {
self.0.alternate_bases()
}
/// Returns the filters.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_vcf::variant::record::Filters;
/// let record = bcf::Record::default();
/// assert!(record.filters().is_empty());
/// ```
pub fn filters(&self) -> Filters<'_> {
self.0.filters()
}
/// Returns the info.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_vcf::variant::record::Info;
/// let record = bcf::Record::default();
/// assert!(record.info().is_empty());
/// ```
pub fn info(&self) -> Info<'_> {
self.0.info()
}
/// Returns the samples.
///
/// # Examples
///
/// ```
/// use noodles_bcf as bcf;
/// use noodles_vcf::variant::record::Samples;
/// let record = bcf::Record::default();
/// assert!(record.samples()?.is_empty());
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn samples(&self) -> io::Result<Samples<'_>> {
self.0.samples()
}
}
impl fmt::Debug for Record {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Record")
.field("reference_sequence_id", &self.reference_sequence_id())
.field("position", &self.variant_start())
.field("ids", &self.ids())
.field("reference_bases", &self.reference_bases())
.field("alternate_bases", &self.alternate_bases())
.field("quality_score", &self.quality_score())
.field("filters", &self.filters())
.field("info", &self.info())
.field("samples", &self.samples())
.finish()
}
}
impl vcf::variant::Record for Record {
fn reference_sequence_name<'a, 'h: 'a>(
&'a self,
header: &'h vcf::Header,
) -> io::Result<&'a str> {
self.reference_sequence_name(header.string_maps())
}
fn variant_start(&self) -> Option<io::Result<Position>> {
self.variant_start()
}
fn ids(&self) -> Box<dyn vcf::variant::record::Ids + '_> {
Box::new(self.ids())
}
fn reference_bases(&self) -> Box<dyn vcf::variant::record::ReferenceBases + '_> {
Box::new(self.reference_bases())
}
fn alternate_bases(&self) -> Box<dyn vcf::variant::record::AlternateBases + '_> {
Box::new(self.alternate_bases())
}
fn quality_score(&self) -> Option<io::Result<f32>> {
self.quality_score().transpose()
}
fn filters(&self) -> Box<dyn vcf::variant::record::Filters + '_> {
Box::new(self.filters())
}
fn info(&self) -> Box<dyn vcf::variant::record::Info + '_> {
Box::new(self.info())
}
fn samples(&self) -> io::Result<Box<dyn vcf::variant::record::Samples + '_>> {
self.samples()
.map(|samples| Box::new(samples) as Box<dyn vcf::variant::record::Samples>)
}
}