Struct OptionBuilder

pub struct OptionBuilder(/* private fields */);

A builder of options objects.

Implementations

impl OptionBuilder

pub fn volume(&mut self, volume: Volume) -> &mut Self

Set the volume.

pub fn mode(&mut self, mode: Mode) -> &mut Self

Set rare or raw mode.

pub fn timeout(&mut self, timeout: u8) -> &mut Self

Set the timeout in deciseconds (0.1s).

pub fn pathological_size(&mut self, size: usize) -> &mut Self

Set the minimum length for pathological ANSI escape sequences.

This method ensures that the given size is at least double the read buffer size, updating it if necessary.

pub fn read_buffer_size(&mut self, size: usize) -> &mut Self

Set the read buffer size.

This method also updates the pathological size to twice the given size.

The read buffer must be large enough to hold the entire escape sequence being recognized. When querying colors, that is 27 bytes: A response for the 16th ANSI color bright white starts with ‹OSC›4;15;rgb: followed by three four-digit hexadecimal numbers separated by forward slashes, such as ffff/ffff/ffff, and then the terminating ‹ST›. Both OSC and ST require at most two bytes, resulting in a maximum sequence length of 27 bytes.

This method ensures that the pathological size is at least double the given size, updating it if necessary.

pub fn write_buffer_size(&mut self, size: usize) -> &mut Self

Set the write buffer size.

pub fn build(&self) -> Options

Instantiate the options.

Trait Implementations

impl Debug for OptionBuilder

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

Formats the value using the given formatter.