#[cfg(feature = "ba2")]
pub mod ba2;
#[cfg(any(feature = "bsa-tes3", feature = "bsa-tes4"))]
pub mod bsa;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
mod builder_fs;
#[cfg(feature = "ba2")]
mod dds;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
mod extract;
#[cfg(any(feature = "ba2", feature = "bsa-tes4"))]
mod inflate;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
mod lookup;
#[cfg(feature = "luau")]
pub mod luau;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
mod read;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
mod storage;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
mod stream;
pub use dream_path;
#[cfg(any(feature = "ba2", feature = "bsa-tes4"))]
pub use flate2;
use std::io::{self, Read};
pub struct Copied<'copy>(pub &'copy [u8]);
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum FileFormat {
BA2,
BSA(BsaFormat),
}
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum BsaFormat {
TES3,
TES4,
}
pub fn guess_format(input: &mut impl Read) -> io::Result<Option<FileFormat>> {
let mut magic = [0; 4];
input.read_exact(&mut magic)?;
Ok(match &magic {
#[cfg(feature = "ba2")]
b"BTDX" => Some(FileFormat::BA2),
#[cfg(feature = "bsa-tes4")]
b"BSA\0" => Some(FileFormat::BSA(BsaFormat::TES4)),
#[cfg(feature = "bsa-tes3")]
[0, 1, 0, 0] => Some(FileFormat::BSA(BsaFormat::TES3)),
_ => None,
})
}
pub use dream_path::bstr;
pub use dream_path::bstr::{BStr, BString, ByteSlice, ByteVec};
#[cfg(feature = "ba2")]
pub type Ba2Builder = ba2::Builder;
#[cfg(feature = "ba2")]
pub type Ba2Dx10Builder = ba2::Dx10Builder;
#[cfg(feature = "bsa-tes3")]
pub type Tes3BsaBuilder = bsa::tes3::Builder;
#[cfg(feature = "bsa-tes4")]
pub type Tes4BsaBuilder = bsa::tes4::Builder;
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub enum CompressionOverride {
#[default]
Inherit,
Store,
Compress,
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
pub type Result<T> = std::result::Result<T, Error>;
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
UnknownFormat,
FileNotFound(BString),
Io(io::Error),
#[cfg(feature = "ba2")]
Ba2(ba2::Error),
#[cfg(any(feature = "bsa-tes3", feature = "bsa-tes4"))]
Bsa(bsa::Error),
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::UnknownFormat => f.write_str("unknown or disabled archive format"),
Self::FileNotFound(path) => write!(f, "archive member not found: {path}"),
Self::Io(error) => error.fmt(f),
#[cfg(feature = "ba2")]
Self::Ba2(error) => error.fmt(f),
#[cfg(any(feature = "bsa-tes3", feature = "bsa-tes4"))]
Self::Bsa(error) => error.fmt(f),
}
}
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Self::Io(error) => Some(error),
#[cfg(feature = "ba2")]
Self::Ba2(error) => Some(error),
#[cfg(any(feature = "bsa-tes3", feature = "bsa-tes4"))]
Self::Bsa(error) => Some(error),
_ => None,
}
}
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl From<io::Error> for Error {
fn from(error: io::Error) -> Self {
Self::Io(error)
}
}
#[cfg(feature = "ba2")]
impl From<ba2::Error> for Error {
fn from(error: ba2::Error) -> Self {
Self::Ba2(error)
}
}
#[cfg(any(feature = "bsa-tes3", feature = "bsa-tes4"))]
impl From<bsa::Error> for Error {
fn from(error: bsa::Error) -> Self {
Self::Bsa(error)
}
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
#[derive(Clone, Debug)]
pub enum Archive {
#[cfg(feature = "ba2")]
BA2(ba2::Archive),
#[cfg(feature = "bsa-tes3")]
Tes3Bsa(bsa::tes3::Archive),
#[cfg(feature = "bsa-tes4")]
Tes4Bsa(bsa::tes4::Archive),
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
#[derive(Clone, Copy, Debug)]
pub enum Entry<'a> {
#[cfg(feature = "ba2")]
BA2(&'a ba2::Entry),
#[cfg(feature = "bsa-tes3")]
Tes3Bsa(&'a bsa::tes3::Entry),
#[cfg(feature = "bsa-tes4")]
Tes4Bsa(&'a bsa::tes4::Entry),
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
#[derive(Clone, Debug)]
pub enum Entries<'a> {
#[cfg(feature = "ba2")]
BA2(std::slice::Iter<'a, ba2::Entry>),
#[cfg(feature = "bsa-tes3")]
Tes3Bsa(std::slice::Iter<'a, bsa::tes3::Entry>),
#[cfg(feature = "bsa-tes4")]
Tes4Bsa(std::slice::Iter<'a, bsa::tes4::Entry>),
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl<'a> Iterator for Entries<'a> {
type Item = Entry<'a>;
fn next(&mut self) -> Option<Self::Item> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(entries) => entries.next().map(Entry::BA2),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(entries) => entries.next().map(Entry::Tes3Bsa),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(entries) => entries.next().map(Entry::Tes4Bsa),
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
match self {
#[cfg(feature = "ba2")]
Self::BA2(entries) => entries.size_hint(),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(entries) => entries.size_hint(),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(entries) => entries.size_hint(),
}
}
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl ExactSizeIterator for Entries<'_> {}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl std::iter::FusedIterator for Entries<'_> {}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl<'a> Entry<'a> {
#[must_use]
pub fn path(self) -> Option<&'a BStr> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(entry) => (!entry.name().is_empty()).then(|| entry.name()),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(entry) => Some(entry.path()),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(entry) => entry.path(),
}
}
#[must_use]
pub fn format(self) -> FileFormat {
match self {
#[cfg(feature = "ba2")]
Self::BA2(_) => FileFormat::BA2,
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(_) => FileFormat::BSA(BsaFormat::TES3),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(_) => FileFormat::BSA(BsaFormat::TES4),
}
}
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
impl Archive {
pub fn open_path(path: impl AsRef<std::path::Path>) -> Result<Self> {
let path = path.as_ref();
match detect_path(path)? {
#[cfg(feature = "ba2")]
Some(FileFormat::BA2) => Ok(Self::BA2(ba2::Archive::open_path(path)?)),
#[cfg(feature = "bsa-tes3")]
Some(FileFormat::BSA(BsaFormat::TES3)) => {
Ok(Self::Tes3Bsa(bsa::tes3::Archive::open_path(path)?))
}
#[cfg(feature = "bsa-tes4")]
Some(FileFormat::BSA(BsaFormat::TES4)) => {
Ok(Self::Tes4Bsa(bsa::tes4::Archive::open_path(path)?))
}
_ => Err(Error::UnknownFormat),
}
}
pub fn from_slice(bytes: &[u8]) -> Result<Self> {
let mut cursor = std::io::Cursor::new(bytes);
match guess_format(&mut cursor)? {
#[cfg(feature = "ba2")]
Some(FileFormat::BA2) => Ok(Self::BA2(ba2::Archive::from_slice(bytes)?)),
#[cfg(feature = "bsa-tes3")]
Some(FileFormat::BSA(BsaFormat::TES3)) => {
Ok(Self::Tes3Bsa(bsa::tes3::Archive::from_slice(bytes)?))
}
#[cfg(feature = "bsa-tes4")]
Some(FileFormat::BSA(BsaFormat::TES4)) => {
Ok(Self::Tes4Bsa(bsa::tes4::Archive::from_slice(bytes)?))
}
_ => Err(Error::UnknownFormat),
}
}
pub fn from_vec(bytes: Vec<u8>) -> Result<Self> {
let mut cursor = std::io::Cursor::new(bytes.as_slice());
match guess_format(&mut cursor)? {
#[cfg(feature = "ba2")]
Some(FileFormat::BA2) => Ok(Self::BA2(ba2::Archive::from_vec(bytes)?)),
#[cfg(feature = "bsa-tes3")]
Some(FileFormat::BSA(BsaFormat::TES3)) => {
Ok(Self::Tes3Bsa(bsa::tes3::Archive::from_vec(bytes)?))
}
#[cfg(feature = "bsa-tes4")]
Some(FileFormat::BSA(BsaFormat::TES4)) => {
Ok(Self::Tes4Bsa(bsa::tes4::Archive::from_vec(bytes)?))
}
_ => Err(Error::UnknownFormat),
}
}
#[must_use]
pub fn format(&self) -> FileFormat {
match self {
#[cfg(feature = "ba2")]
Self::BA2(_) => FileFormat::BA2,
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(_) => FileFormat::BSA(BsaFormat::TES3),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(_) => FileFormat::BSA(BsaFormat::TES4),
}
}
#[must_use]
pub fn len(&self) -> usize {
match self {
#[cfg(feature = "ba2")]
Self::BA2(archive) => archive.len(),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(archive) => archive.len(),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(archive) => archive.len(),
}
}
#[must_use]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
#[must_use]
pub fn entries(&self) -> Entries<'_> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(archive) => Entries::BA2(archive.entries().iter()),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(archive) => Entries::Tes3Bsa(archive.entries().iter()),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(archive) => Entries::Tes4Bsa(archive.entries().iter()),
}
}
pub fn read_file(&self, path: impl AsRef<[u8]>) -> Result<Option<Vec<u8>>> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(archive) => Ok(archive.read_file(path)?),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(archive) => Ok(archive.read_file(path)?),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(archive) => Ok(archive.read_file(path)?),
}
}
pub fn read_file_required(&self, path: impl AsRef<[u8]>) -> Result<Vec<u8>> {
let path = path.as_ref();
self.read_file(path)?
.ok_or_else(|| Error::FileNotFound(BString::from(path)))
}
pub fn extract_file(
&self,
path: impl AsRef<[u8]>,
out: impl std::io::Write,
) -> Result<Option<u64>> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(archive) => Ok(archive.extract_file(path, out)?),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(archive) => Ok(archive.extract_file(path, out)?),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(archive) => Ok(archive.extract_file(path, out)?),
}
}
pub fn extract_file_required(
&self,
path: impl AsRef<[u8]>,
out: impl std::io::Write,
) -> Result<u64> {
let path = path.as_ref();
self.extract_file(path, out)?
.ok_or_else(|| Error::FileNotFound(BString::from(path)))
}
pub fn open_file(&self, path: impl AsRef<[u8]>) -> Result<Option<Box<dyn Read + '_>>> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(archive) => Ok(archive.open_file(path)?),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(archive) => Ok(archive.open_file(path)?),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(archive) => Ok(archive.open_file(path)?),
}
}
pub fn open_file_required(&self, path: impl AsRef<[u8]>) -> Result<Box<dyn Read + '_>> {
let path = path.as_ref();
self.open_file(path)?
.ok_or_else(|| Error::FileNotFound(BString::from(path)))
}
pub fn extract_to(&self, target_dir: impl AsRef<std::path::Path>) -> Result<u64> {
match self {
#[cfg(feature = "ba2")]
Self::BA2(archive) => Ok(archive.extract_to(target_dir)?),
#[cfg(feature = "bsa-tes3")]
Self::Tes3Bsa(archive) => Ok(archive.extract_to(target_dir)?),
#[cfg(feature = "bsa-tes4")]
Self::Tes4Bsa(archive) => Ok(archive.extract_to(target_dir)?),
}
}
}
#[cfg(any(feature = "ba2", feature = "bsa-tes3", feature = "bsa-tes4"))]
pub fn detect_path(path: impl AsRef<std::path::Path>) -> io::Result<Option<FileFormat>> {
let mut file = std::fs::File::open(path)?;
guess_format(&mut file)
}