Trait Script

Source

pub trait Script: Debug + Any {
Show 30 methods    // Required methods
    fn default_output_script_type(&self) -> OutputScriptType;
    fn default_format_type(&self) -> FormatOptions;

    // Provided methods
    fn is_output_supported(&self, output: OutputScriptType) -> bool { ... }
    fn custom_output_extension<'a>(&'a self) -> &'a str { ... }
    fn multiple_message_files(&self) -> bool { ... }
    fn extract_messages(&self) -> Result<Vec<Message>> { ... }
    fn extract_multiple_messages(&self) -> Result<HashMap<String, Vec<Message>>> { ... }
    fn import_messages<'a>(
        &'a self,
        _messages: Vec<Message>,
        _file: Box<dyn WriteSeek + 'a>,
        _filename: &str,
        _encoding: Encoding,
        _replacement: Option<&'a ReplacementTable>,
    ) -> Result<()> { ... }
    fn import_multiple_messages<'a>(
        &'a self,
        _messages: HashMap<String, Vec<Message>>,
        _file: Box<dyn WriteSeek + 'a>,
        _filename: &str,
        _encoding: Encoding,
        _replacement: Option<&'a ReplacementTable>,
    ) -> Result<()> { ... }
    fn import_messages_filename(
        &self,
        messages: Vec<Message>,
        filename: &str,
        encoding: Encoding,
        replacement: Option<&ReplacementTable>,
    ) -> Result<()> { ... }
    fn import_multiple_messages_filename(
        &self,
        messages: HashMap<String, Vec<Message>>,
        filename: &str,
        encoding: Encoding,
        replacement: Option<&ReplacementTable>,
    ) -> Result<()> { ... }
    fn custom_export(&self, _filename: &Path, _encoding: Encoding) -> Result<()> { ... }
    fn custom_import<'a>(
        &'a self,
        _custom_filename: &'a str,
        _file: Box<dyn WriteSeek + 'a>,
        _encoding: Encoding,
        _output_encoding: Encoding,
    ) -> Result<()> { ... }
    fn custom_import_filename(
        &self,
        custom_filename: &str,
        filename: &str,
        encoding: Encoding,
        output_encoding: Encoding,
    ) -> Result<()> { ... }
    fn is_archive(&self) -> bool { ... }
    fn iter_archive_filename<'a>(
        &'a self,
    ) -> Result<Box<dyn Iterator<Item = Result<String>> + 'a>> { ... }
    fn iter_archive_offset<'a>(
        &'a self,
    ) -> Result<Box<dyn Iterator<Item = Result<u64>> + 'a>> { ... }
    fn open_file<'a>(
        &'a self,
        _index: usize,
    ) -> Result<Box<dyn ArchiveContent + 'a>> { ... }
    fn open_file_by_name<'a>(
        &'a self,
        name: &str,
        ignore_case: bool,
    ) -> Result<Box<dyn ArchiveContent + 'a>> { ... }
    fn open_file_by_offset<'a>(
        &'a self,
        offset: u64,
    ) -> Result<Box<dyn ArchiveContent + 'a>> { ... }
    fn archive_output_ext<'a>(&'a self) -> Option<&'a str> { ... }
    fn is_image(&self) -> bool { ... }
    fn export_image(&self) -> Result<ImageData> { ... }
    fn import_image<'a>(
        &'a self,
        _data: ImageData,
        _file: Box<dyn WriteSeek + 'a>,
    ) -> Result<()> { ... }
    fn import_image_filename(
        &self,
        data: ImageData,
        filename: &str,
    ) -> Result<()> { ... }
    fn is_multi_image(&self) -> bool { ... }
    fn export_multi_image<'a>(
        &'a self,
    ) -> Result<Box<dyn Iterator<Item = Result<ImageDataWithName>> + 'a>> { ... }
    fn import_multi_image<'a>(
        &'a self,
        _data: Vec<ImageDataWithName>,
        _file: Box<dyn WriteSeek + 'a>,
    ) -> Result<()> { ... }
    fn import_multi_image_filename(
        &self,
        data: Vec<ImageDataWithName>,
        filename: &str,
    ) -> Result<()> { ... }
    fn extra_info<'a>(&'a self) -> Option<Box<dyn AnyDebug + 'a>> { ... }
}

Expand description

A trait for script types.

Required Methods§

Source

fn default_output_script_type(&self) -> OutputScriptType

Returns the default output script type for this script.

Source

fn default_format_type(&self) -> FormatOptions

Returns the default format options for this script.

Provided Methods§

Source

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

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

Source

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

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

Source

fn multiple_message_files(&self) -> bool

Returns true if this script can contains multiple message files.

Source

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

Extract messages from this script.

Source

fn extract_multiple_messages(&self) -> Result<HashMap<String, Vec<Message>>>

Extract multiple messages from this script.

Source

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.

messages - The messages to import.
file - A writer with seek capabilities to write the patched scripts.
filename - The path of the file to write the patched scripts.
encoding - The encoding to use for the patched scripts.
replacement - An optional replacement table for message replacements.

Source

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

Import multiple messages into this script.

messages - A map of filenames to messages to import.
file - A writer with seek capabilities to write the patched scripts.
filename - The path of the file to write the patched scripts.
encoding - The encoding to use for the patched scripts.
replacement - An optional replacement table for message replacements.s

Source

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

Import messages into this script.

messages - The messages to import.
filename - The path of the file to write the patched scripts.
encoding - The encoding to use for the patched scripts.
replacement - An optional replacement table for message replacements.

Source

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

Import multiple messages into this script.

messages - A map of filenames to messages to import.
filename - The path of the file to write the patched scripts.
encoding - The encoding to use for the patched scripts.
replacement - An optional replacement table for message replacements.

Source

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

Exports data from this script.

filename - The path of the file to write the exported data.
encoding - The encoding to use for the exported data.

Source

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.

custom_filename - The path of the file to import.
file - A writer with seek capabilities to write the patched scripts.
encoding - The encoding of the patched scripts.
output_encoding - The encoding to use for the imported file.

Source

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

Imports data into this script.

custom_filename - The path of the file to import.
filename - The path of the file to write the patched scripts.
encoding - The encoding of the patched scripts.
output_encoding - The encoding to use for the imported file.

Source

fn is_archive(&self) -> bool

Returns true if this script is an archive.

Source

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

Returns an iterator over archive filenames.

Source

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

Returns an iterator over archive offsets.

Source

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

Opens a file in the archive by its index.

Source

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.

name - The name of the file to open.
ignore_case - If true, the name comparison will be case-insensitive.

Source

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

Opens a file in the archive by its offset.

Source