Struct GeneratorOptions 

pub struct GeneratorOptions { /* private fields */ }

Generator options parsed from a Lua table.

Implementations

impl GeneratorOptions

pub fn new() -> Self

Creates an empty option set.

pub fn insert(&mut self, name: impl Into<String>, value: GeneratorOption)

Inserts or replaces one named option.

pub fn required_usize(&self, name: &str) -> PulseResult<usize>

Reads a required positive usize option.

Errors

Returns an error when the option is missing, non-integer, zero, or too large.

pub fn usize_or(&self, name: &str, default: usize) -> PulseResult<usize>

Reads an optional positive usize option.

Errors

Returns an error when the supplied option is non-integer, zero, or too large.

pub fn required_u32(&self, name: &str) -> PulseResult<u32>

Reads a required non-negative u32 option.

Errors

Returns an error when the option is missing, negative, non-integer, or too large.

pub fn u32_or(&self, name: &str, default: u32) -> PulseResult<u32>

Reads an optional non-negative u32 option.

Errors

Returns an error when the supplied option is negative, non-integer, or too large.

pub fn f32_or(&self, name: &str, default: f32) -> PulseResult<f32>

Reads an optional finite f32 option.

Errors

Returns an error when the supplied option is not numeric or not finite.

pub fn required_f32(&self, name: &str) -> PulseResult<f32>

Reads a required finite f32 option.

Errors

Returns an error when the option is missing, not numeric, or not finite.

pub fn bool_or(&self, name: &str, default: bool) -> PulseResult<bool>

Reads an optional boolean option.

Errors

Returns an error when the supplied option is not boolean.

pub fn required_text(&self, name: &str) -> PulseResult<&str>

Reads a required string option.

Errors

Returns an error when the option is missing or not text.

pub fn required_text_map( &self, name: &str, ) -> PulseResult<&BTreeMap<String, String>>

Reads a required string-to-string map option.

Errors

Returns an error when the option is missing or not a text map.

Trait Implementations

impl Clone for GeneratorOptions

fn clone(&self) -> GeneratorOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeneratorOptions

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

Formats the value using the given formatter.

impl Default for GeneratorOptions

fn default() -> GeneratorOptions

Returns the “default value” for a type.

impl PartialEq for GeneratorOptions

fn eq(&self, other: &GeneratorOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GeneratorOptions