Struct mysql_common::constants::StatusFlags

pub struct StatusFlags { /* private fields */ }

MySql server status flags

Implementations

impl StatusFlags

pub const SERVER_STATUS_IN_TRANS: Self = _

Is raised when a multi-statement transaction has been started, either explicitly, by means of BEGIN or COMMIT AND CHAIN, or implicitly, by the first transactional statement, when autocommit=off.

pub const SERVER_STATUS_AUTOCOMMIT: Self = _

Server in auto_commit mode.

pub const SERVER_MORE_RESULTS_EXISTS: Self = _

Multi query - next query exists.

pub const SERVER_STATUS_NO_GOOD_INDEX_USED: Self = _

pub const SERVER_STATUS_NO_INDEX_USED: Self = _

pub const SERVER_STATUS_CURSOR_EXISTS: Self = _

The server was able to fulfill the clients request and opened a read-only non-scrollable cursor for a query. This flag comes in reply to COM_STMT_EXECUTE and COM_STMT_FETCH commands. Used by Binary Protocol Resultset to signal that COM_STMT_FETCH must be used to fetch the row-data.

pub const SERVER_STATUS_LAST_ROW_SENT: Self = _

This flag is sent when a read-only cursor is exhausted, in reply to COM_STMT_FETCH command.

pub const SERVER_STATUS_DB_DROPPED: Self = _

A database was dropped.

pub const SERVER_STATUS_NO_BACKSLASH_ESCAPES: Self = _

pub const SERVER_STATUS_METADATA_CHANGED: Self = _

Sent to the client if after a prepared statement reprepare we discovered that the new statement returns a different number of result set columns.

pub const SERVER_QUERY_WAS_SLOW: Self = _

pub const SERVER_PS_OUT_PARAMS: Self = _

To mark ResultSet containing output parameter values.

pub const SERVER_STATUS_IN_TRANS_READONLY: Self = _

Set at the same time as SERVER_STATUS_IN_TRANS if the started multi-statement transaction is a read-only transaction. Cleared when the transaction commits or aborts. Since this flag is sent to clients in OK and EOF packets, the flag indicates the transaction status at the end of command execution.

pub const SERVER_SESSION_STATE_CHANGED: Self = _

This status flag, when on, implies that one of the state information has changed on the server because of the execution of the last statement.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

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<Self>

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) -> Self

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

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

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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: Self) -> Self

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: Self) -> Self

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: Self) -> Self

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) -> Self

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 StatusFlags

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

Formats the value using the given formatter.

impl BitAnd for StatusFlags

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

Returns the intersection between the two sets of flags.

type Output = StatusFlags

The resulting type after applying the & operator.

impl BitAndAssign for StatusFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for StatusFlags

fn bitor(self, other: StatusFlags) -> Self

Returns the union of the two sets of flags.

type Output = StatusFlags

The resulting type after applying the | operator.

impl BitOrAssign for StatusFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for StatusFlags

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

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

type Output = StatusFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for StatusFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Bitflags for StatusFlags

type Repr = u16

fn empty() -> Self

fn all() -> Self

fn bits(&self) -> Self::Repr

fn from_bits(bits: Self::Repr) -> Option<Self>

fn from_bits_truncate(bits: Self::Repr) -> Self

unsafe fn from_bits_unchecked(bits: Self::Repr) -> Self

Safety

fn is_empty(&self) -> bool

fn is_all(&self) -> bool

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

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

fn insert(&mut self, other: Self)

fn remove(&mut self, other: Self)

fn toggle(&mut self, other: Self)

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

impl Clone for StatusFlags

fn clone(&self) -> StatusFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StatusFlags

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

Formats the value using the given formatter.

impl Default for StatusFlags

fn default() -> StatusFlags

Returns the “default value” for a type.

impl Extend<StatusFlags> for StatusFlags

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

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 From<StatusFlags> for u16

fn from(val: StatusFlags) -> u16

Converts to this type from the input type.

impl FromIterator<StatusFlags> for StatusFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for StatusFlags

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 LowerHex for StatusFlags

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

Formats the value using the given formatter.

impl Not for StatusFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = StatusFlags

The resulting type after applying the ! operator.

impl Octal for StatusFlags

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

Formats the value using the given formatter.

impl Ord for StatusFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StatusFlags

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

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

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

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

impl PartialOrd for StatusFlags

fn partial_cmp(&self, other: &StatusFlags) -> 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 for StatusFlags

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

Returns the set difference of the two sets of flags.

type Output = StatusFlags

The resulting type after applying the - operator.

impl SubAssign for StatusFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl TryFrom<u16> for StatusFlags

type Error = UnknownStatusFlags

The type returned in the event of a conversion error.

fn try_from(val: u16) -> Result<StatusFlags, UnknownStatusFlags>

Performs the conversion.

impl UpperHex for StatusFlags

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

Formats the value using the given formatter.

impl Copy for StatusFlags

impl Eq for StatusFlags

impl StructuralEq for StatusFlags

impl StructuralPartialEq for StatusFlags