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
use std::{
ffi::{OsStr, OsString},
fs::File,
io::{self, Read},
path::{Path, PathBuf},
};
use noodles_fasta as fasta;
use super::IndexedReader;
use crate::crai;
/// An indexed CRAM reader builder.
#[derive(Default)]
pub struct Builder {
reference_sequence_repository: fasta::Repository,
index: Option<crai::Index>,
}
impl Builder {
/// Sets the reference sequence repository.
///
/// # Examples
///
/// ```
/// use noodles_cram::io::indexed_reader::Builder;
/// use noodles_fasta as fasta;
///
/// let reference_sequence_repository = fasta::Repository::default();
/// let builder = Builder::default()
/// .set_reference_sequence_repository(reference_sequence_repository);
/// ```
pub fn set_reference_sequence_repository(
mut self,
reference_sequence_repository: fasta::Repository,
) -> Self {
self.reference_sequence_repository = reference_sequence_repository;
self
}
/// Sets an index.
///
/// # Examples
///
/// ```
/// use noodles_cram::{crai, io::indexed_reader::Builder};
/// let index = crai::Index::default();
/// let builder = Builder::default().set_index(index);
/// ```
pub fn set_index(mut self, index: crai::Index) -> Self {
self.index = Some(index);
self
}
/// Builds an indexed CRAM reader from a path.
///
/// If no index is set, this will attempt to read an associated index at `<src>.crai`.
///
/// # Examples
///
/// ```no_run
/// use noodles_cram::io::indexed_reader::Builder;
/// let builder = Builder::default().build_from_path("sample.cram")?;
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn build_from_path<P>(mut self, src: P) -> io::Result<IndexedReader<File>>
where
P: AsRef<Path>,
{
let src = src.as_ref();
if self.index.is_none() {
let index_src = build_index_src(src);
self.index = crai::read(index_src).map(Some)?;
}
let file = File::open(src)?;
self.build_from_reader(file)
}
/// Builds an indexed CRAM reader from a reader.
///
/// # Examples
///
/// ```
/// # use std::io;
/// use noodles_cram::{crai, io::indexed_reader::Builder};
///
/// let index = crai::Index::default();
/// let builder = Builder::default()
/// .set_index(index)
/// .build_from_reader(io::empty())?;
/// # Ok::<_, std::io::Error>(())
/// ```
pub fn build_from_reader<R>(self, reader: R) -> io::Result<IndexedReader<R>>
where
R: Read,
{
let inner = crate::io::reader::Builder::default()
.set_reference_sequence_repository(self.reference_sequence_repository)
.build_from_reader(reader);
let index = self
.index
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "missing index"))?;
Ok(IndexedReader { inner, index })
}
}
fn build_index_src<P>(src: P) -> PathBuf
where
P: AsRef<Path>,
{
const EXT: &str = "crai";
push_ext(src.as_ref().into(), EXT)
}
fn push_ext<S>(path: PathBuf, ext: S) -> PathBuf
where
S: AsRef<OsStr>,
{
let mut s = OsString::from(path);
s.push(".");
s.push(ext);
PathBuf::from(s)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_build_index_src() {
assert_eq!(
build_index_src("sample.cram"),
PathBuf::from("sample.cram.crai")
);
}
}