Struct mysql_async::consts::CapabilityFlags
source · pub struct CapabilityFlags { /* private fields */ }
Expand description
Client capability flags
Implementations§
source§impl CapabilityFlags
impl CapabilityFlags
sourcepub const CLIENT_LONG_PASSWORD: CapabilityFlags = Self{ bits: 1,}
pub const CLIENT_LONG_PASSWORD: CapabilityFlags = Self{ bits: 1,}
Use the improved version of Old Password Authentication. Assumed to be set since 4.1.1.
sourcepub const CLIENT_FOUND_ROWS: CapabilityFlags = Self{ bits: 2,}
pub const CLIENT_FOUND_ROWS: CapabilityFlags = Self{ bits: 2,}
Send found rows instead of affected rows in EOF_Packet.
sourcepub const CLIENT_LONG_FLAG: CapabilityFlags = Self{ bits: 4,}
pub const CLIENT_LONG_FLAG: CapabilityFlags = Self{ bits: 4,}
sourcepub const CLIENT_CONNECT_WITH_DB: CapabilityFlags = Self{ bits: 8,}
pub const CLIENT_CONNECT_WITH_DB: CapabilityFlags = Self{ bits: 8,}
sourcepub const CLIENT_NO_SCHEMA: CapabilityFlags = Self{ bits: 16,}
pub const CLIENT_NO_SCHEMA: CapabilityFlags = Self{ bits: 16,}
Don’t allow database.table.column.
sourcepub const CLIENT_COMPRESS: CapabilityFlags = Self{ bits: 32,}
pub const CLIENT_COMPRESS: CapabilityFlags = Self{ bits: 32,}
sourcepub const CLIENT_ODBC: CapabilityFlags = Self{ bits: 64,}
pub const CLIENT_ODBC: CapabilityFlags = Self{ bits: 64,}
Special handling of ODBC behavior.
sourcepub const CLIENT_LOCAL_FILES: CapabilityFlags = Self{ bits: 128,}
pub const CLIENT_LOCAL_FILES: CapabilityFlags = Self{ bits: 128,}
sourcepub const CLIENT_IGNORE_SPACE: CapabilityFlags = Self{ bits: 256,}
pub const CLIENT_IGNORE_SPACE: CapabilityFlags = Self{ bits: 256,}
pub const CLIENT_PROTOCOL_41: CapabilityFlags = Self{ bits: 512,}
sourcepub const CLIENT_INTERACTIVE: CapabilityFlags = Self{ bits: 1024,}
pub const CLIENT_INTERACTIVE: CapabilityFlags = Self{ bits: 1024,}
sourcepub const CLIENT_SSL: CapabilityFlags = Self{ bits: 2048,}
pub const CLIENT_SSL: CapabilityFlags = Self{ bits: 2048,}
sourcepub const CLIENT_IGNORE_SIGPIPE: CapabilityFlags = Self{ bits: 4096,}
pub const CLIENT_IGNORE_SIGPIPE: CapabilityFlags = Self{ bits: 4096,}
Client only flag. Not used.
Client
Do not issue SIGPIPE if network failures occur (libmysqlclient only).
sourcepub const CLIENT_TRANSACTIONS: CapabilityFlags = Self{ bits: 8192,}
pub const CLIENT_TRANSACTIONS: CapabilityFlags = Self{ bits: 8192,}
pub const CLIENT_RESERVED: CapabilityFlags = Self{ bits: 16384,}
pub const CLIENT_SECURE_CONNECTION: CapabilityFlags = Self{ bits: 32768,}
sourcepub const CLIENT_MULTI_STATEMENTS: CapabilityFlags = Self{ bits: 65536,}
pub const CLIENT_MULTI_STATEMENTS: CapabilityFlags = Self{ bits: 65536,}
sourcepub const CLIENT_MULTI_RESULTS: CapabilityFlags = Self{ bits: 131072,}
pub const CLIENT_MULTI_RESULTS: CapabilityFlags = Self{ bits: 131072,}
sourcepub const CLIENT_PS_MULTI_RESULTS: CapabilityFlags = Self{ bits: 262144,}
pub const CLIENT_PS_MULTI_RESULTS: CapabilityFlags = Self{ bits: 262144,}
sourcepub const CLIENT_PLUGIN_AUTH: CapabilityFlags = Self{ bits: 524288,}
pub const CLIENT_PLUGIN_AUTH: CapabilityFlags = Self{ bits: 524288,}
sourcepub const CLIENT_CONNECT_ATTRS: CapabilityFlags = Self{ bits: 1048576,}
pub const CLIENT_CONNECT_ATTRS: CapabilityFlags = Self{ bits: 1048576,}
sourcepub const CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA: CapabilityFlags = Self{ bits: 2097152,}
pub const CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA: CapabilityFlags = Self{ bits: 2097152,}
Enable authentication response packet to be larger than 255 bytes. When the ability to change default plugin require that the initial password field in the Protocol::HandshakeResponse41 paclet can be of arbitrary size. However, the 4.1 client-server protocol limits the length of the auth-data-field sent from client to server to 255 bytes. The solution is to change the type of the field to a true length encoded string and indicate the protocol change with this client capability flag.
Server
Understands length-encoded integer for auth response data in Protocol::HandshakeResponse41.
Client
Length of auth response data in Protocol::HandshakeResponse41 is a length-encoded integer.
Note
The flag was introduced in 5.6.6, but had the wrong value.
sourcepub const CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS: CapabilityFlags = Self{ bits: 4194304,}
pub const CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS: CapabilityFlags = Self{ bits: 4194304,}
sourcepub const CLIENT_SESSION_TRACK: CapabilityFlags = Self{ bits: 8388608,}
pub const CLIENT_SESSION_TRACK: CapabilityFlags = Self{ bits: 8388608,}
Capable of handling server state change information. Its a hint to the server to include the state change information in OK_Packet.
Server
Can set SERVER_SESSION_STATE_CHANGED in the SERVER_STATUS_flags_enum and send Session State Information in a OK_Packet.
Client
Expects the server to send Session State Information in a OK_Packet.
sourcepub const CLIENT_DEPRECATE_EOF: CapabilityFlags = Self{ bits: 16777216,}
pub const CLIENT_DEPRECATE_EOF: CapabilityFlags = Self{ bits: 16777216,}
Client no longer needs EOF_Packet and will use OK_Packet instead.
Server
Can send OK after a Text Resultset.
Client
Expects an OK_Packet (instead of EOF_Packet) after the resultset rows of a Text Resultset.
Background
To support CLIENT_SESSION_TRACK, additional information must be sent after all successful commands. Although the OK_Packet is extensible, the EOF_Packet is not due to the overlap of its bytes with the content of the Text Resultset Row.
Therefore, the EOF_Packet in the Text Resultset is replaced with an OK_Packet. EOF_Packet is deprecated as of MySQL 5.7.5.
sourcepub const CLIENT_PROGRESS_OBSOLETE: CapabilityFlags = Self{ bits: 536870912,}
pub const CLIENT_PROGRESS_OBSOLETE: CapabilityFlags = Self{ bits: 536870912,}
Client or server supports progress reports within error packet.
sourcepub const CLIENT_SSL_VERIFY_SERVER_CERT: CapabilityFlags = Self{ bits: 1073741824,}
pub const CLIENT_SSL_VERIFY_SERVER_CERT: CapabilityFlags = Self{ bits: 1073741824,}
Verify server certificate. Client only flag.
Deprecated in favor of –ssl-mode.
sourcepub const CLIENT_REMEMBER_OPTIONS: CapabilityFlags = Self{ bits: 2147483648,}
pub const CLIENT_REMEMBER_OPTIONS: CapabilityFlags = Self{ bits: 2147483648,}
Don’t reset the options after an unsuccessful connect. Client only flag.
sourcepub const fn empty() -> CapabilityFlags
pub const fn empty() -> CapabilityFlags
Returns an empty set of flags.
sourcepub const fn all() -> CapabilityFlags
pub const fn all() -> CapabilityFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<CapabilityFlags>
pub const fn from_bits(bits: u32) -> Option<CapabilityFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> CapabilityFlags
pub const fn from_bits_truncate(bits: u32) -> CapabilityFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> CapabilityFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> CapabilityFlags
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.
sourcepub const fn intersects(&self, other: CapabilityFlags) -> bool
pub const fn intersects(&self, other: CapabilityFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: CapabilityFlags) -> bool
pub const fn contains(&self, other: CapabilityFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: CapabilityFlags)
pub fn insert(&mut self, other: CapabilityFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: CapabilityFlags)
pub fn remove(&mut self, other: CapabilityFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: CapabilityFlags)
pub fn toggle(&mut self, other: CapabilityFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: CapabilityFlags, value: bool)
pub fn set(&mut self, other: CapabilityFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: CapabilityFlags) -> CapabilityFlags
pub const fn intersection(self, other: CapabilityFlags) -> CapabilityFlags
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
.
sourcepub const fn union(self, other: CapabilityFlags) -> CapabilityFlags
pub const fn union(self, other: CapabilityFlags) -> CapabilityFlags
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
.
sourcepub const fn difference(self, other: CapabilityFlags) -> CapabilityFlags
pub const fn difference(self, other: CapabilityFlags) -> CapabilityFlags
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
.
sourcepub const fn symmetric_difference(
self,
other: CapabilityFlags
) -> CapabilityFlags
pub const fn symmetric_difference(
self,
other: CapabilityFlags
) -> CapabilityFlags
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
.
sourcepub const fn complement(self) -> CapabilityFlags
pub const fn complement(self) -> CapabilityFlags
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§
source§impl Binary for CapabilityFlags
impl Binary for CapabilityFlags
source§impl BitAnd<CapabilityFlags> for CapabilityFlags
impl BitAnd<CapabilityFlags> for CapabilityFlags
source§fn bitand(self, other: CapabilityFlags) -> CapabilityFlags
fn bitand(self, other: CapabilityFlags) -> CapabilityFlags
Returns the intersection between the two sets of flags.
§type Output = CapabilityFlags
type Output = CapabilityFlags
&
operator.source§impl BitAndAssign<CapabilityFlags> for CapabilityFlags
impl BitAndAssign<CapabilityFlags> for CapabilityFlags
source§fn bitand_assign(&mut self, other: CapabilityFlags)
fn bitand_assign(&mut self, other: CapabilityFlags)
Disables all flags disabled in the set.
source§impl BitOr<CapabilityFlags> for CapabilityFlags
impl BitOr<CapabilityFlags> for CapabilityFlags
source§fn bitor(self, other: CapabilityFlags) -> CapabilityFlags
fn bitor(self, other: CapabilityFlags) -> CapabilityFlags
Returns the union of the two sets of flags.
§type Output = CapabilityFlags
type Output = CapabilityFlags
|
operator.source§impl BitOrAssign<CapabilityFlags> for CapabilityFlags
impl BitOrAssign<CapabilityFlags> for CapabilityFlags
source§fn bitor_assign(&mut self, other: CapabilityFlags)
fn bitor_assign(&mut self, other: CapabilityFlags)
Adds the set of flags.
source§impl BitXor<CapabilityFlags> for CapabilityFlags
impl BitXor<CapabilityFlags> for CapabilityFlags
source§fn bitxor(self, other: CapabilityFlags) -> CapabilityFlags
fn bitxor(self, other: CapabilityFlags) -> CapabilityFlags
Returns the left flags, but with all the right flags toggled.
§type Output = CapabilityFlags
type Output = CapabilityFlags
^
operator.source§impl BitXorAssign<CapabilityFlags> for CapabilityFlags
impl BitXorAssign<CapabilityFlags> for CapabilityFlags
source§fn bitxor_assign(&mut self, other: CapabilityFlags)
fn bitxor_assign(&mut self, other: CapabilityFlags)
Toggles the set of flags.
source§impl Clone for CapabilityFlags
impl Clone for CapabilityFlags
source§fn clone(&self) -> CapabilityFlags
fn clone(&self) -> CapabilityFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CapabilityFlags
impl Debug for CapabilityFlags
source§impl Extend<CapabilityFlags> for CapabilityFlags
impl Extend<CapabilityFlags> for CapabilityFlags
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = CapabilityFlags>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = CapabilityFlags>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<CapabilityFlags> for CapabilityFlags
impl FromIterator<CapabilityFlags> for CapabilityFlags
source§fn from_iter<T>(iterator: T) -> CapabilityFlagswhere
T: IntoIterator<Item = CapabilityFlags>,
fn from_iter<T>(iterator: T) -> CapabilityFlagswhere
T: IntoIterator<Item = CapabilityFlags>,
source§impl Hash for CapabilityFlags
impl Hash for CapabilityFlags
source§impl LowerHex for CapabilityFlags
impl LowerHex for CapabilityFlags
source§impl Not for CapabilityFlags
impl Not for CapabilityFlags
source§fn not(self) -> CapabilityFlags
fn not(self) -> CapabilityFlags
Returns the complement of this set of flags.
§type Output = CapabilityFlags
type Output = CapabilityFlags
!
operator.source§impl Octal for CapabilityFlags
impl Octal for CapabilityFlags
source§impl Ord for CapabilityFlags
impl Ord for CapabilityFlags
source§fn cmp(&self, other: &CapabilityFlags) -> Ordering
fn cmp(&self, other: &CapabilityFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<CapabilityFlags> for CapabilityFlags
impl PartialEq<CapabilityFlags> for CapabilityFlags
source§fn eq(&self, other: &CapabilityFlags) -> bool
fn eq(&self, other: &CapabilityFlags) -> bool
source§impl PartialOrd<CapabilityFlags> for CapabilityFlags
impl PartialOrd<CapabilityFlags> for CapabilityFlags
source§fn partial_cmp(&self, other: &CapabilityFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CapabilityFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<CapabilityFlags> for CapabilityFlags
impl Sub<CapabilityFlags> for CapabilityFlags
source§fn sub(self, other: CapabilityFlags) -> CapabilityFlags
fn sub(self, other: CapabilityFlags) -> CapabilityFlags
Returns the set difference of the two sets of flags.
§type Output = CapabilityFlags
type Output = CapabilityFlags
-
operator.source§impl SubAssign<CapabilityFlags> for CapabilityFlags
impl SubAssign<CapabilityFlags> for CapabilityFlags
source§fn sub_assign(&mut self, other: CapabilityFlags)
fn sub_assign(&mut self, other: CapabilityFlags)
Disables all flags enabled in the set.