Struct BgiArchiveBuilder

pub struct BgiArchiveBuilder {}

Available on crate features bgi and bgi-arc only.

Builder for BGI Archive Version 1 scripts.

Implementations

impl BgiArchiveBuilder

pub const fn new() -> Self

Creates a new instance of BgiArchiveBuilder.

Trait Implementations

impl Debug for BgiArchiveBuilder

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

Formats the value using the given formatter.

impl ScriptBuilder for BgiArchiveBuilder

fn default_encoding(&self) -> Encoding

Returns the default encoding for the script.

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

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

fn build_script( &self, data: 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.

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.

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.

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.

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.

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.

fn default_patched_encoding(&self) -> Encoding

Returns the default encoding for script files when patching scripts.

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.

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.

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.

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.