Struct PfscImage 

pub struct PfscImage<I: Image> { /* private fields */ }

A decompressing Image adapter for PFSC-compressed files.

Each PFSC block is independently compressed, so read_at at any offset only needs to decompress one block (or two if straddling a boundary). All state is local to each call — no shared mutable state, naturally thread-safe.

Created via PfscImage::open().

Example

use orbis_pfs::image::Image;
use orbis_pfs::pfsc::PfscImage;

let pfsc = PfscImage::open(source)?;
let pfs = orbis_pfs::open_image(pfsc)?;

Implementations

impl<I: Image> PfscImage<I>

pub fn open(source: I) -> Result<Self, OpenError>

Opens a PFSC-compressed image from an underlying Image source.

Reads the PFSC header and block offset table at construction time.

pub fn decompressed_len(&self) -> u64

Returns the decompressed size of the file.

Trait Implementations

impl<I: Image> Debug for PfscImage<I>

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

Formats the value using the given formatter.

impl<I: Image> Image for PfscImage<I>

fn read_at(&self, offset: u64, buf: &mut [u8]) -> Result<usize>

Reads bytes from the image at the given offset into buf.

fn len(&self) -> u64

Returns the total length of the image in bytes.

fn read_exact_at(&self, offset: u64, output_buf: &mut [u8]) -> Result<()>

Reads exactly buf.len() bytes from image at offset.

fn is_empty(&self) -> bool

Returns true if the image is empty.