Struct opensrv_mysql::ColumnFlags

pub struct ColumnFlags { /* private fields */ }

MySql column flags

Implementations

impl ColumnFlags

pub const NOT_NULL_FLAG: ColumnFlags = Self{bits: 1u16,}

Field can’t be NULL.

pub const PRI_KEY_FLAG: ColumnFlags = Self{bits: 2u16,}

Field is part of a primary key.

pub const UNIQUE_KEY_FLAG: ColumnFlags = Self{bits: 4u16,}

Field is part of a unique key.

pub const MULTIPLE_KEY_FLAG: ColumnFlags = Self{bits: 8u16,}

Field is part of a key.

pub const BLOB_FLAG: ColumnFlags = Self{bits: 16u16,}

Field is a blob.

pub const UNSIGNED_FLAG: ColumnFlags = Self{bits: 32u16,}

Field is unsigned.

pub const ZEROFILL_FLAG: ColumnFlags = Self{bits: 64u16,}

Field is zerofill.

pub const BINARY_FLAG: ColumnFlags = Self{bits: 128u16,}

Field is binary.

pub const ENUM_FLAG: ColumnFlags = Self{bits: 256u16,}

Field is an enum.

pub const AUTO_INCREMENT_FLAG: ColumnFlags = Self{bits: 512u16,}

Field is a autoincrement field.

pub const TIMESTAMP_FLAG: ColumnFlags = Self{bits: 1024u16,}

Field is a timestamp.

pub const SET_FLAG: ColumnFlags = Self{bits: 2048u16,}

Field is a set.

pub const NO_DEFAULT_VALUE_FLAG: ColumnFlags = Self{bits: 4096u16,}

Field doesn’t have default value.

pub const ON_UPDATE_NOW_FLAG: ColumnFlags = Self{bits: 8192u16,}

Field is set to NOW on UPDATE.

pub const PART_KEY_FLAG: ColumnFlags = Self{bits: 16384u16,}

Intern; Part of some key.

pub const NUM_FLAG: ColumnFlags = Self{bits: 32768u16,}

Field is num (for clients).

pub const fn empty() -> ColumnFlags

Returns an empty set of flags.

pub const fn all() -> ColumnFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u16) -> Option<ColumnFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u16) -> ColumnFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u16) -> ColumnFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ColumnFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ColumnFlags) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: ColumnFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ColumnFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ColumnFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ColumnFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: ColumnFlags) -> ColumnFlags

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: ColumnFlags) -> ColumnFlags

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: ColumnFlags) -> ColumnFlags

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: ColumnFlags) -> ColumnFlags

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> ColumnFlags

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for ColumnFlags

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

Formats the value using the given formatter.

impl BitAnd<ColumnFlags> for ColumnFlags

fn bitand(self, other: ColumnFlags) -> ColumnFlags

Returns the intersection between the two sets of flags.

type Output = ColumnFlags

The resulting type after applying the & operator.

impl BitAndAssign<ColumnFlags> for ColumnFlags

fn bitand_assign(&mut self, other: ColumnFlags)

Disables all flags disabled in the set.

impl BitOr<ColumnFlags> for ColumnFlags

fn bitor(self, other: ColumnFlags) -> ColumnFlags

Returns the union of the two sets of flags.

type Output = ColumnFlags

The resulting type after applying the | operator.

impl BitOrAssign<ColumnFlags> for ColumnFlags

fn bitor_assign(&mut self, other: ColumnFlags)

Adds the set of flags.

impl BitXor<ColumnFlags> for ColumnFlags

fn bitxor(self, other: ColumnFlags) -> ColumnFlags

Returns the left flags, but with all the right flags toggled.

type Output = ColumnFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<ColumnFlags> for ColumnFlags

fn bitxor_assign(&mut self, other: ColumnFlags)

Toggles the set of flags.

impl Bitflags for ColumnFlags

type Repr = u16

fn empty() -> ColumnFlags

fn all() -> ColumnFlags

fn bits(&self) -> <ColumnFlags as Bitflags>::Repr

fn from_bits(bits: <ColumnFlags as Bitflags>::Repr) -> Option<ColumnFlags>

fn from_bits_truncate(bits: <ColumnFlags as Bitflags>::Repr) -> ColumnFlags

unsafe fn from_bits_unchecked(
    bits: <ColumnFlags as Bitflags>::Repr
) -> ColumnFlags

Safety

fn is_empty(&self) -> bool

fn is_all(&self) -> bool

fn intersects(&self, other: ColumnFlags) -> bool

fn contains(&self, other: ColumnFlags) -> bool

fn insert(&mut self, other: ColumnFlags)

fn remove(&mut self, other: ColumnFlags)

fn toggle(&mut self, other: ColumnFlags)

fn set(&mut self, other: ColumnFlags, value: bool)

impl Clone for ColumnFlags

fn clone(&self) -> ColumnFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnFlags

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

Formats the value using the given formatter.

impl Default for ColumnFlags

fn default() -> ColumnFlags

Returns the “default value” for a type.

impl Extend<ColumnFlags> for ColumnFlags

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = ColumnFlags>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ColumnFlags> for ColumnFlags

fn from_iter<T>(iterator: T) -> ColumnFlags where
    T: IntoIterator<Item = ColumnFlags>, 

Creates a value from an iterator.

impl Hash for ColumnFlags

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for ColumnFlags

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

Formats the value using the given formatter.

impl Not for ColumnFlags

fn not(self) -> ColumnFlags

Returns the complement of this set of flags.

type Output = ColumnFlags

The resulting type after applying the ! operator.

impl Octal for ColumnFlags

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

Formats the value using the given formatter.

impl Ord for ColumnFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ColumnFlags> for ColumnFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ColumnFlags> for ColumnFlags

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<ColumnFlags> for ColumnFlags

fn sub(self, other: ColumnFlags) -> ColumnFlags

Returns the set difference of the two sets of flags.

type Output = ColumnFlags

The resulting type after applying the - operator.

impl SubAssign<ColumnFlags> for ColumnFlags

fn sub_assign(&mut self, other: ColumnFlags)

Disables all flags enabled in the set.

impl TryFrom<u16> for ColumnFlags

type Error = UnknownColumnFlags

The type returned in the event of a conversion error.

fn try_from(val: u16) -> Result<ColumnFlags, UnknownColumnFlags>

Performs the conversion.

impl UpperHex for ColumnFlags

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

Formats the value using the given formatter.

impl Copy for ColumnFlags

impl Eq for ColumnFlags

impl StructuralEq for ColumnFlags

impl StructuralPartialEq for ColumnFlags