Struct Xbc1

pub struct Xbc1 {
    pub compression_type: CompressionType,
    pub decompressed_size: u32,
    pub compressed_size: u32,
    pub decompressed_hash: u32,
    pub name: String,
    pub compressed_stream: Vec<u8>,
}

A compressed container for a single file or stream.

Fields

compression_type: CompressionType

The compression type for compressed_stream.

decompressed_size: u32

The number of bytes in Self::decompress.

compressed_size: u32

The number of bytes in compressed_stream.

decompressed_hash: u32

Hash of the original decompressed bytes for compressed_stream using hash_crc.

name: String

The name for this archive. This is often the name of the original file like 3d4f4c6_middle.witx.

compressed_stream: Vec<u8>

A compressed stream encoded based on compression_type. The decompressed stream will have size decompressed_size.

Implementations

impl Xbc1

pub fn new<T>( name: String, data: &T, compression_type: CompressionType, ) -> Result<Self, CreateXbc1Error>

where T: WriteFull<Args = ()>,

Write and compress data. Use CompressionType::Zlib for best compatibility.

pub fn from_decompressed( name: String, decompressed: &[u8], compression_type: CompressionType, ) -> Result<Self, CreateXbc1Error>

Compress the data in decompressed. Use CompressionType::Zlib for best compatibility.

pub fn decompress(&self) -> Result<Vec<u8>, DecompressStreamError>

Decompresses the data in compressed_stream.

Unlike Self::decompress_check_hash, this skips a slow hashing check for the decompressed data.

pub fn decompress_check_hash(&self) -> Result<Vec<u8>, DecompressStreamError>

Similar to Self::decompress but returns an error if the hash of the decompressed data does not match.

pub fn extract<T>(&self) -> Result<T, DecompressStreamError>

where for<'a> T: BinRead<Args<'a> = ()>,

Decompress and parse the decompressed data.

impl Xbc1

pub fn write<W: Write + Seek>(&self, writer: &mut W) -> Xc3Result<()>

pub fn save<P: AsRef<Path>>(&self, path: P) -> Xc3Result<()>

Write to path using a buffered writer for better performance.

pub fn to_bytes(&self) -> Xc3Result<Vec<u8>>

Write the result of Self::write to a byte buffer.

impl Xbc1

pub fn read<R: Read + Seek>(reader: &mut R) -> BinResult<Self>

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ReadFileError>

Read from path using a fully buffered reader for performance.

pub fn from_bytes<T: AsRef<[u8]>>(bytes: T) -> BinResult<Self>

Read from bytes using a fully buffered reader for performance.

Trait Implementations

impl BinRead for Xbc1

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl BinWrite for Xbc1

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_ne<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments.

impl Clone for Xbc1

fn clone(&self) -> Xbc1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Xbc1

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

Formats the value using the given formatter.

impl PartialEq for Xbc1

fn eq(&self, other: &Xbc1) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReadMagic for Xbc1

const MAGIC: Self::MagicType

The magic number.

type MagicType = [u8; 4]

The type of the magic number.

impl WriteMagic for Xbc1

const MAGIC: Self::MagicType

The magic number.

type MagicType = [u8; 4]

The type of the magic number.

impl Xc3Write for Xbc1

const ALIGNMENT: u64 = 16u64

The alignment of absolute offsets for this type in bytes.

type Offsets<'a> = ()

The type storing offset data to be used in Xc3WriteOffsets.

fn xc3_write<W: Write + Seek>( &self, writer: &mut W, endian: Endian, ) -> Xc3Result<Self::Offsets<'_>>

Write all fields and placeholder offsets. This should almost always be derived for non primitive types.

fn should_write(&self) -> Option<bool>

Return Some(_) if the offset should be updated and Some(true) if the data should also be written. Defaults to Some(true).

impl StructuralPartialEq for Xbc1