Struct ResourcePackage

pub struct ResourcePackage { /* private fields */ }

Implementations

impl ResourcePackage

pub fn from_file<P: AsRef<Path> + Copy>( package_path: P, ) -> Result<Self, ResourcePackageError>

Parses a ResourcePackage from a file.

Arguments

• package_path - The path to the file to parse.

pub fn from_memory( data: Vec<u8>, is_patch: bool, ) -> Result<Self, ResourcePackageError>

Parses a ResourcePackage from a memory buffer.

Arguments

• data - The data to parse.
• is_patch - Whether the package is a patch package.

pub fn version(&self) -> PackageVersion

Returns the version of the package.

pub fn source(&self) -> Option<&ResourcePackageSource>

Returns the source of the package.

pub fn resources(&self) -> &IndexMap<RuntimeResourceID, ResourceInfo>

Returns a map of the RuntimeResourceIds and their resource information.

pub fn has_legacy_references(&self) -> bool

Returns whether the package uses the legacy references format.

pub fn has_unneeded_resource(&self, rrid: &RuntimeResourceID) -> bool

Returns whether the given resource is an unneeded resource.

Arguments

• rrid - The resource ID to check.

pub fn unneeded_resource_ids(&self) -> Vec<&RuntimeResourceID>

Returns a vector of all unneeded resource IDs.

pub fn read_resource( &self, rrid: &RuntimeResourceID, ) -> Result<Vec<u8>, ResourcePackageError>

Reads the data of a resource from the package into memory.

Arguments

• rrid - The resource ID of the resource to read.

Trait Implementations

impl BinRead for ResourcePackage

type Args<'__binrw_generated_args_lifetime> = (bool,)

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<R>(reader: &mut R) -> Result<Self, Error>

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

Read Self from the reader using default 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_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

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 ResourcePackage

type Args<'__binrw_generated_args_lifetime> = (bool,)

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<W>(&self, writer: &mut W) -> Result<(), Error>

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

Write Self to the writer using default 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_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

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.

impl ReadEndian for ResourcePackage

const ENDIAN: EndianKind

The endianness of the type.

impl WriteEndian for ResourcePackage

const ENDIAN: EndianKind

The endianness of the type.