Struct PckArchive

pub struct PckArchive<T: Read + Seek + Debug> {
    reader: Arc<Mutex<T>>,
    entries: Vec<PckFileHeader>,
}

Available on crate features circus and circus-arc only.

PCK Archive

Fields

reader: Arc<Mutex<T>>

entries: Vec<PckFileHeader>

Implementations

impl<T: Read + Seek + Debug> PckArchive<T>

pub fn new( reader: T, archive_encoding: Encoding, _config: &ExtraConfig, ) -> Result<Self>

Creates a new PckArchive from a reader.

• reader - The reader to read the PCK archive from.
• archive_encoding - The encoding to use for string fields in the archive.
• config - Extra configuration options.

Trait Implementations

impl<T: Debug + Read + Seek + Debug> Debug for PckArchive<T>

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

Formats the value using the given formatter.

impl<T: Read + Seek + Debug + 'static> Script for PckArchive<T>

fn default_output_script_type(&self) -> OutputScriptType

Returns the default output script type for this script.

fn default_format_type(&self) -> FormatOptions

Returns the default format options for this script.

fn is_archive(&self) -> bool

Returns true if this script is an archive.

fn iter_archive_filename<'a>( &'a self, ) -> Result<Box<dyn Iterator<Item = Result<String>> + 'a>>

Returns an iterator over archive filenames.

fn iter_archive_offset<'a>( &'a self, ) -> Result<Box<dyn Iterator<Item = Result<u64>> + 'a>>

Returns an iterator over archive offsets.

fn open_file<'a>(&'a self, index: usize) -> Result<Box<dyn ArchiveContent + 'a>>

Opens a file in the archive by its index.

fn is_output_supported(&self, output: OutputScriptType) -> bool

Checks if the given output script type is supported by this script.

fn custom_output_extension<'a>(&'a self) -> &'a str

Returns the output extension for this script when exporting with custom output.

fn extract_messages(&self) -> Result<Vec<Message>>

Extract messages from this script.

fn import_messages<'a>( &'a self, _messages: Vec<Message>, _file: Box<dyn WriteSeek + 'a>, _filename: &str, _encoding: Encoding, _replacement: Option<&'a ReplacementTable>, ) -> Result<()>

Import messages into this script.

fn import_messages_filename( &self, messages: Vec<Message>, filename: &str, encoding: Encoding, replacement: Option<&ReplacementTable>, ) -> Result<()>

Import messages into this script.

fn custom_export(&self, _filename: &Path, _encoding: Encoding) -> Result<()>

Exports data from this script.

fn custom_import<'a>( &'a self, _custom_filename: &'a str, _file: Box<dyn WriteSeek + 'a>, _encoding: Encoding, _output_encoding: Encoding, ) -> Result<()>

Imports data into this script.

fn custom_import_filename( &self, custom_filename: &str, filename: &str, encoding: Encoding, output_encoding: Encoding, ) -> Result<()>

Imports data into this script.

fn open_file_by_name<'a>( &'a self, name: &str, ignore_case: bool, ) -> Result<Box<dyn ArchiveContent + 'a>>

Opens a file in the archive by its name.

fn open_file_by_offset<'a>( &'a self, offset: u64, ) -> Result<Box<dyn ArchiveContent + 'a>>

Opens a file in the archive by its offset.

fn archive_output_ext<'a>(&'a self) -> Option<&'a str>

Returns output extension for archive output folder.

fn is_image(&self) -> bool

Available on crate feature image only.

Returns true if this script type is an image.

fn export_image(&self) -> Result<ImageData>

Available on crate feature image only.

Exports the image data from this script.

fn import_image<'a>( &'a self, _data: ImageData, _file: Box<dyn WriteSeek + 'a>, ) -> Result<()>

Available on crate feature image only.

Imports an image into this script.

fn import_image_filename(&self, data: ImageData, filename: &str) -> Result<()>

Available on crate feature image only.

Imports an image into this script.

fn is_multi_image(&self) -> bool

Available on crate feature image only.

Returns true if this script is contains multiple images.

fn export_multi_image<'a>( &'a self, ) -> Result<Box<dyn Iterator<Item = Result<ImageDataWithName>> + 'a>>

Available on crate feature image only.

Exports multiple images from this script.

fn import_multi_image<'a>( &'a self, _data: Vec<ImageDataWithName>, _file: Box<dyn WriteSeek + 'a>, ) -> Result<()>

Available on crate feature image only.

Imports multiple images into this script.

fn import_multi_image_filename( &self, data: Vec<ImageDataWithName>, filename: &str, ) -> Result<()>

Available on crate feature image only.

Imports multiple images into this script.

fn extra_info<'a>(&'a self) -> Option<Box<dyn AnyDebug + 'a>>

Returns the extra information for this script.