Struct FileReadOptions

pub struct FileReadOptions { /* private fields */ }

Common parameters to configure how files are read.

use ba2::{
    fo4::{CompressionFormat, CompressionLevel, FileReadOptions, Format},
    CompressionResult,
};

// Read and compress a file for FO4/FO76, GNRL format
let _ = FileReadOptions::builder()
    .format(Format::GNRL)
    .compression_format(CompressionFormat::Zip)
    .compression_level(CompressionLevel::FO4)
    .compression_result(CompressionResult::Compressed)
    .build();

// Read and compress a file for FO4/FO76, DX10 format
let _ = FileReadOptions::builder()
    .format(Format::DX10)
    .compression_format(CompressionFormat::Zip)
    .compression_level(CompressionLevel::FO4)
    .compression_result(CompressionResult::Compressed)
    .build();

// Read and compress a file for FO4 on the xbox, GNRL format
let _ = FileReadOptions::builder()
    .format(Format::GNRL)
    .compression_format(CompressionFormat::Zip)
    .compression_level(CompressionLevel::FO4Xbox)
    .compression_result(CompressionResult::Compressed)
    .build();

// Read and compress a file for FO4 on the xbox, DX10 format
let _ = FileReadOptions::builder()
    .format(Format::DX10)
    .compression_format(CompressionFormat::Zip)
    .compression_level(CompressionLevel::FO4Xbox)
    .compression_result(CompressionResult::Compressed)
    .build();

// Read and compress a file for SF, GNRL format
let _ = FileReadOptions::builder()
    .format(Format::GNRL)
    .compression_format(CompressionFormat::Zip)
    .compression_level(CompressionLevel::SF)
    .compression_result(CompressionResult::Compressed)
    .build();

// Read and compress a file for SF, DX10 format
let _ = FileReadOptions::builder()
    .format(Format::DX10)
    .compression_format(CompressionFormat::LZ4)
    .compression_result(CompressionResult::Compressed)
    .build();

Implementations

impl ReadOptions

pub fn builder() -> ReadOptionsBuilder

pub fn compression_format(&self) -> CompressionFormat

pub fn compression_level(&self) -> CompressionLevel

pub fn compression_result(&self) -> CompressionResult

pub fn format(&self) -> Format

pub fn mip_chunk_height(&self) -> usize

pub fn mip_chunk_width(&self) -> usize

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> ReadOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadOptions

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

Formats the value using the given formatter.

impl Default for ReadOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&Options> for ReadOptions

fn from(value: &ArchiveOptions) -> Self

Converts to this type from the input type.

impl From<Options> for ReadOptions

fn from(value: ArchiveOptions) -> Self

Converts to this type from the input type.

impl Copy for ReadOptions