Trait ScriptBuilder

pub trait ScriptBuilder: Debug {
    // Required methods
    fn default_encoding(&self) -> Encoding;
    fn build_script(
        &self,
        buf: Vec<u8>,
        filename: &str,
        encoding: Encoding,
        archive_encoding: Encoding,
        config: &ExtraConfig,
        archive: Option<&Box<dyn Script>>,
    ) -> Result<Box<dyn Script>>;
    fn extensions(&self) -> &'static [&'static str];
    fn script_type(&self) -> &'static ScriptType;

    // Provided methods
    fn default_archive_encoding(&self) -> Option<Encoding> { ... }
    fn default_patched_encoding(&self) -> Encoding { ... }
    fn build_script_from_file(
        &self,
        filename: &str,
        encoding: Encoding,
        archive_encoding: Encoding,
        config: &ExtraConfig,
        archive: Option<&Box<dyn Script>>,
    ) -> Result<Box<dyn Script>> { ... }
    fn build_script_from_reader(
        &self,
        reader: Box<dyn ReadSeek>,
        filename: &str,
        encoding: Encoding,
        archive_encoding: Encoding,
        config: &ExtraConfig,
        archive: Option<&Box<dyn Script>>,
    ) -> Result<Box<dyn Script>> { ... }
    fn is_this_format(
        &self,
        _filename: &str,
        _buf: &[u8],
        _buf_len: usize,
    ) -> Option<u8> { ... }
    fn is_archive(&self) -> bool { ... }
    fn create_archive(
        &self,
        _filename: &str,
        _files: &[&str],
        _encoding: Encoding,
        _config: &ExtraConfig,
    ) -> Result<Box<dyn Archive>> { ... }
    fn can_create_file(&self) -> bool { ... }
    fn create_file<'a>(
        &'a self,
        _filename: &'a str,
        _writer: Box<dyn WriteSeek + 'a>,
        _encoding: Encoding,
        _file_encoding: Encoding,
        _config: &ExtraConfig,
    ) -> Result<()> { ... }
    fn create_file_filename(
        &self,
        filename: &str,
        output_filename: &str,
        encoding: Encoding,
        file_encoding: Encoding,
        config: &ExtraConfig,
    ) -> Result<()> { ... }
    fn is_image(&self) -> bool { ... }
    fn can_create_image_file(&self) -> bool { ... }
    fn create_image_file<'a>(
        &'a self,
        _data: ImageData,
        _writer: Box<dyn WriteSeek + 'a>,
        _options: &ExtraConfig,
    ) -> Result<()> { ... }
    fn create_image_file_filename(
        &self,
        data: ImageData,
        filename: &str,
        options: &ExtraConfig,
    ) -> Result<()> { ... }
}

A trait for script builders.

Required Methods

fn default_encoding(&self) -> Encoding

Returns the default encoding for the script.

fn build_script( &self, buf: Vec<u8>, filename: &str, encoding: Encoding, archive_encoding: Encoding, config: &ExtraConfig, archive: Option<&Box<dyn Script>>, ) -> Result<Box<dyn Script>>

Builds a script from the given buffer.

• buf - The buffer containing the script data.
• filename - The name of the file from which the script was read.
• encoding - The encoding of the script data.
• archive_encoding - The encoding of the archive, if applicable.
• config - Additional configuration options.
• archive - An optional archive to which the script belongs.

fn extensions(&self) -> &'static [&'static str]

Returns the extensions supported by this script builder.

fn script_type(&self) -> &'static ScriptType

Returns the script type associated with this builder.

Provided Methods

fn default_archive_encoding(&self) -> Option<Encoding>

Returns the default encoding for the archive. If None, the default encoding should be used.

fn default_patched_encoding(&self) -> Encoding

Returns the default encoding for script files when patching scripts.

fn build_script_from_file( &self, filename: &str, encoding: Encoding, archive_encoding: Encoding, config: &ExtraConfig, archive: Option<&Box<dyn Script>>, ) -> Result<Box<dyn Script>>

Builds a script from a file.

• filename - The name of the file to read.
• encoding - The encoding of the script data.
• archive_encoding - The encoding of the archive, if applicable.
• config - Additional configuration options.
• archive - An optional archive to which the script belongs.

fn build_script_from_reader( &self, reader: Box<dyn ReadSeek>, filename: &str, encoding: Encoding, archive_encoding: Encoding, config: &ExtraConfig, archive: Option<&Box<dyn Script>>, ) -> Result<Box<dyn Script>>

Builds a script from a reader.

• reader - A reader with seek capabilities.
• filename - The name of the file from which the script was read.
• encoding - The encoding of the script data.
• archive_encoding - The encoding of the archive, if applicable.
• config - Additional configuration options.
• archive - An optional archive to which the script belongs.

fn is_this_format( &self, _filename: &str, _buf: &[u8], _buf_len: usize, ) -> Option<u8>

Checks if the given filename and buffer match this script format.

• filename - The name of the file to check.
• buf - The buffer containing the script data.
• buf_len - The length of the buffer.

Returns a score (0-255) indicating how well the format matches. A higher score means a better match.

fn is_archive(&self) -> bool

Returns true if this script is an archive.

fn create_archive( &self, _filename: &str, _files: &[&str], _encoding: Encoding, _config: &ExtraConfig, ) -> Result<Box<dyn Archive>>

Creates an archive with the given files.

• filename - The path of the archive file to create.
• files - A list of files to include in the archive.
• encoding - The encoding to use for the archive.
• config - Additional configuration options.

fn can_create_file(&self) -> bool

Returns true if this script type can create from a file directly.

fn create_file<'a>( &'a self, _filename: &'a str, _writer: Box<dyn WriteSeek + 'a>, _encoding: Encoding, _file_encoding: Encoding, _config: &ExtraConfig, ) -> Result<()>

Creates a new script file.

• filename - The path to the input file.
• writer - A writer with seek capabilities to write the script data.
• encoding - The encoding to use for the script data.
• file_encoding - The encoding of the file.
• config - Additional configuration options.

fn create_file_filename( &self, filename: &str, output_filename: &str, encoding: Encoding, file_encoding: Encoding, config: &ExtraConfig, ) -> Result<()>

Creates a new script file with the given filename.

• filename - The path to the input file.
• output_filename - The path to the output file.
• encoding - The encoding to use for the script data.
• file_encoding - The encoding of the file.
• config - Additional configuration options.

fn is_image(&self) -> bool

Available on crate feature image only.

Returns true if this script is an image.

fn can_create_image_file(&self) -> bool

Available on crate feature image only.

Returns true if this script type can create from an image file directly.

fn create_image_file<'a>( &'a self, _data: ImageData, _writer: Box<dyn WriteSeek + 'a>, _options: &ExtraConfig, ) -> Result<()>

Available on crate feature image only.

Creates an image file from the given data.

• data - The image data to write.
• writer - A writer with seek capabilities to write the image data.
• options - Additional configuration options.

fn create_image_file_filename( &self, data: ImageData, filename: &str, options: &ExtraConfig, ) -> Result<()>

Available on crate feature image only.

Creates an image file from the given data to the specified filename.

• data - The image data to write.
• filename - The path to the output file.
• options - Additional configuration options.

Implementors

impl ScriptBuilder for ArtemisArcBuilder

Available on crate features artemis-arc and artemis only.

impl ScriptBuilder for ArtemisAsbBuilder

Available on crate feature artemis only.

impl ScriptBuilder for AstScriptBuilder

Available on crate feature artemis only.

impl ScriptBuilder for TxtBuilder

Available on crate feature artemis only.

impl ScriptBuilder for DscBuilder

Available on crate features bgi-arc and bgi only.

impl ScriptBuilder for msg_tool::scripts::bgi::archive::v1::BgiArchiveBuilder

Available on crate features bgi-arc and bgi only.

impl ScriptBuilder for msg_tool::scripts::bgi::archive::v2::BgiArchiveBuilder

Available on crate features bgi-arc and bgi only.

impl ScriptBuilder for BgiAudioBuilder

Available on crate features bgi-audio and bgi only.

impl ScriptBuilder for BGIBpScriptBuilder

Available on crate feature bgi only.

impl ScriptBuilder for BGIBsiScriptBuilder

Available on crate feature bgi only.

impl ScriptBuilder for BgiCBGBuilder

Available on crate features bgi-img and bgi only.

impl ScriptBuilder for BgiImageBuilder

Available on crate features bgi-img and bgi only.

impl ScriptBuilder for BGIScriptBuilder

Available on crate feature bgi only.

impl ScriptBuilder for CSIntArcBuilder

Available on crate features cat-system-arc and cat-system only.

impl ScriptBuilder for CstScriptBuilder

Available on crate feature cat-system only.

impl ScriptBuilder for CstlScriptBuilder

Available on crate feature cat-system only.

impl ScriptBuilder for Hg3ImageBuilder

Available on crate features cat-system-img and cat-system only.

impl ScriptBuilder for CrmArchiveBuilder

Available on crate features circus-arc and circus only.

impl ScriptBuilder for DatArchiveBuilder

Available on crate features circus-arc and circus only.

impl ScriptBuilder for PckArchiveBuilder

Available on crate features circus-arc and circus only.

impl ScriptBuilder for PcmBuilder

Available on crate features circus-audio and circus only.

impl ScriptBuilder for CrxImageBuilder

Available on crate features circus-img and circus only.

impl ScriptBuilder for CrxdImageBuilder

Available on crate features circus-img and circus only.

impl ScriptBuilder for CircusMesScriptBuilder

Available on crate feature circus only.

impl ScriptBuilder for DrefBuilder

Available on crate feature emote-img only.

impl ScriptBuilder for PImgBuilder

Available on crate feature emote-img only.

impl ScriptBuilder for SrcXmlScriptBuilder

Available on crate feature entis-gls only.

impl ScriptBuilder for EscudeBinArchiveBuilder

Available on crate features escude-arc and escude only.

impl ScriptBuilder for EscudeBinListBuilder

Available on crate feature escude only.

impl ScriptBuilder for EscudeBinScriptBuilder

Available on crate feature escude only.

impl ScriptBuilder for RldScriptBuilder

Available on crate feature ex-hibit only.

impl ScriptBuilder for BinScriptBuilder

Available on crate feature hexen-haus only.

impl ScriptBuilder for TlgImageBuilder

Available on crate features kirikiri-img and kirikiri only.

impl ScriptBuilder for KsBuilder

Available on crate feature kirikiri only.

impl ScriptBuilder for MdfBuilder

Available on crate feature kirikiri only.

impl ScriptBuilder for ScnScriptBuilder

Available on crate feature kirikiri only.

impl ScriptBuilder for SimpleCryptBuilder

Available on crate feature kirikiri only.

impl ScriptBuilder for SoftpalScriptBuilder

Available on crate feature softpal only.

impl ScriptBuilder for Ws2ScriptBuilder

Available on crate feature will-plus only.

impl ScriptBuilder for ItufuruArchiveBuilder

Available on crate features yaneurao-itufuru and yaneurao only.

impl ScriptBuilder for ItufuruScriptBuilder

Available on crate features yaneurao-itufuru and yaneurao only.