Struct Bool

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

A boolean value to use in tables

The boolean type in the plugin API is defined as a 32-bit value, which does not necessarily correspond to the Rust bool type. Since we borrow the actual value, we cannot convert it on the fly to the native Rust type.

This type serves as a wrapper, exposing conversion methods to/from Rust bool.

Trait Implementations

impl Clone for Bool

fn clone(&self) -> Bool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bool

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

Formats the value using the given formatter.

impl From<Bool> for bool

fn from(value: Bool) -> Self

Converts to this type from the input type.

impl From<bool> for Bool

fn from(value: bool) -> Self

Converts to this type from the input type.

impl Hash for Bool

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Bool

fn cmp(&self, other: &Bool) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bool

fn eq(&self, other: &Bool) -> 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 PartialOrd for Bool

fn partial_cmp(&self, other: &Bool) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TableData for Bool

const TYPE_ID: FieldTypeId = FieldTypeId::Bool

The Falco plugin type id of the data

fn to_data(&self) -> ss_plugin_state_data

Convert to the raw FFI representation

impl Copy for Bool

impl Eq for Bool

impl StructuralPartialEq for Bool