Struct ModuleBuilder

pub struct ModuleBuilder { /* private fields */ }

Represents a builder for a Module.

Implementations

impl ModuleBuilder

Public API for ModuleBuilder.

pub fn new() -> Self

Create a new ModuleBuilder.

Arguments

• name: The name of the module.

Returns

• A new ModuleBuilder instance.

Example

use gbf_core::module::ModuleBuilder;

let builder = ModuleBuilder::new();

pub fn name<N: Into<String>>(self, name: N) -> Self

Set the name of the module.

Arguments

• name: The name of the module.

Returns

• A reference to the builder.

Example

use gbf_core::module::ModuleBuilder;

let builder = ModuleBuilder::new().name("test");

pub fn reader(self, reader: Box<dyn Read>) -> Self

Set the reader for the module.

Arguments

• reader: The reader to use for the module.

Returns

• A reference to the builder.

Example

use gbf_core::module::ModuleBuilder;

let builder = ModuleBuilder::new().reader(Box::new(std::io::Cursor::new(vec![0x00, 0x01])));

pub fn build(self) -> Result<Module, ModuleError>

Build the Module from the builder.

Returns

• A new Module instance.

Example

use gbf_core::module::ModuleBuilder;

let module = ModuleBuilder::new().name("test").build().unwrap();

Trait Implementations

impl Default for ModuleBuilder

Default implementation for ModuleBuilder.

fn default() -> Self

Returns the “default value” for a type.