Struct DetectOptions 

pub struct DetectOptions { /* private fields */ }

How the width of a stream is decided, and every default it applies.

A width takes the first of these that applies:

1. an explicit width, which is exact;
2. the window of the stream;
3. COLUMNS, when it holds a number from 1 to 65535;
4. the fallback.

The column buffer and the minimum apply only to the window and COLUMNS. The width that results is at least 1.

Each default has an override and a way to turn it off:

• An explicit width bypasses detection.
• A column buffer of 0 reserves nothing.
• A minimum of 0 sets no floor.
• A fallback of None leaves the width undecided.

The column buffer reads no variable until column_buffer_envs names some.

Implementations

impl DetectOptions

pub const fn new() -> Self

The defaults: no explicit width, a column buffer of DEFAULT_COLUMN_BUFFER read from no variable, a minimum of DEFAULT_MINIMUM_WIDTH, and a fallback of DEFAULT_FALLBACK_WIDTH.

pub const fn width(self, cells: u16) -> Self

Use exactly cells, with no detection, buffer, or minimum. 0 counts as 1.

pub const fn column_buffer(self, cells: u16) -> Self

Reserve cells from a detected width. 0 reserves nothing. This replaces whatever the variables of column_buffer_envs hold.

pub const fn column_buffer_envs(self, names: &'static [&'static str]) -> Self

Read the column buffer from the first of names that holds a number. An empty list reads no variable, which is the default.

pub const fn minimum_width(self, cells: u16) -> Self

Never shrink a detected width below cells, unless the window is narrower. 0 sets no floor.

pub const fn fallback_width(self, cells: Option<u16>) -> Self

Use cells when the stream gives no width and COLUMNS is unset, empty, zero, or not a number from 1 to 65535. None leaves the width undecided, and 0 counts as 1.

Trait Implementations

impl Clone for DetectOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DetectOptions

impl Debug for DetectOptions

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

Formats the value using the given formatter.

impl Default for DetectOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DetectOptions

impl PartialEq for DetectOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DetectOptions