Struct CompositeModule 

pub struct CompositeModule { /* private fields */ }

In-memory composite module made of optional RIM/ERF parts.

Implementations

impl CompositeModule

pub fn from_archives( module_root: impl Into<String>, main_rim: Option<Rim>, supplemental_rim: Option<Rim>, dialog_erf: Option<Erf>, ) -> Result<Self, CompositeModuleError>

Builds a composite module from parsed archive values.

At least one source archive must be present.

pub fn from_archives_with_mod( module_root: impl Into<String>, main_rim: Option<Rim>, supplemental_rim: Option<Rim>, dialog_erf: Option<Erf>, module_mod: Option<Erf>, ) -> Result<Self, CompositeModuleError>

Builds a composite module from parsed archive values, including optional .mod single-file module archive.

At least one source archive must be present.

pub fn from_bytes( module_root: impl Into<String>, main_rim_bytes: Option<&[u8]>, supplemental_rim_bytes: Option<&[u8]>, dialog_erf_bytes: Option<&[u8]>, ) -> Result<Self, CompositeModuleError>

Builds a composite module from optional archive byte slices.

At least one source archive must be provided.

pub fn from_bytes_with_mod( module_root: impl Into<String>, main_rim_bytes: Option<&[u8]>, supplemental_rim_bytes: Option<&[u8]>, dialog_erf_bytes: Option<&[u8]>, module_mod_bytes: Option<&[u8]>, ) -> Result<Self, CompositeModuleError>

Builds a composite module from optional archive byte slices, including optional .mod single-file module archive bytes.

At least one source archive must be provided.

pub fn load_from_directory( directory: impl AsRef<Path>, module_root: impl Into<String>, ) -> Result<Self, CompositeModuleError>

Loads a composite module from a directory and module root name.

Missing source files are treated as absent module parts. At least one of the three canonical part files must exist.

pub fn module_root(&self) -> &str

Returns the module root name used by this composite view.

pub fn has_source(&self, source: CompositeModuleSource) -> bool

Returns true when the specified source archive is present.

pub fn resolve( &self, resref: &ResRef, resource_type: ResourceTypeCode, ) -> Option<ResolvedResource<'_>>

Resolves a resource using composite precedence.

Trait Implementations

impl Clone for CompositeModule

fn clone(&self) -> CompositeModule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompositeModule

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

Formats the value using the given formatter.