Struct mysql_async::consts::CapabilityFlags

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

Client capability flags

Implementations

impl CapabilityFlags

pub const CLIENT_LONG_PASSWORD: CapabilityFlags = _

Use the improved version of Old Password Authentication. Assumed to be set since 4.1.1.

pub const CLIENT_FOUND_ROWS: CapabilityFlags = _

Send found rows instead of affected rows in EOF_Packet.

pub const CLIENT_LONG_FLAG: CapabilityFlags = _

Get all column flags. Longer flags in Protocol::ColumnDefinition320.

Server

Supports longer flags.

Client

Expects longer flags.

pub const CLIENT_CONNECT_WITH_DB: CapabilityFlags = _

Database (schema) name can be specified on connect in Handshake Response Packet.

Server

Supports schema-name in Handshake Response Packet.

Client

Handshake Response Packet contains a schema-name.

pub const CLIENT_NO_SCHEMA: CapabilityFlags = _

Don’t allow database.table.column.

pub const CLIENT_COMPRESS: CapabilityFlags = _

Compression protocol supported.

Server

Supports compression.

Client

Switches to Compression compressed protocol after successful authentication.

pub const CLIENT_ODBC: CapabilityFlags = _

Special handling of ODBC behavior.

pub const CLIENT_LOCAL_FILES: CapabilityFlags = _

Can use LOAD DATA LOCAL.

Server

Enables the LOCAL INFILE request of LOAD DATA|XML.

Client

Will handle LOCAL INFILE request.

pub const CLIENT_IGNORE_SPACE: CapabilityFlags = _

Ignore spaces before ‘(’.

Server

Parser can ignore spaces before ‘(’.

Client

Let the parser ignore spaces before ‘(’.

pub const CLIENT_PROTOCOL_41: CapabilityFlags = _

pub const CLIENT_INTERACTIVE: CapabilityFlags = _

This is an interactive client. Use System_variables::net_wait_timeout versus System_variables::net_interactive_timeout.

Server

Supports interactive and noninteractive clients.

Client

Client is interactive.

pub const CLIENT_SSL: CapabilityFlags = _

Use SSL encryption for the session.

Server

Supports SSL

Client

Switch to SSL after sending the capability-flags.

pub const CLIENT_IGNORE_SIGPIPE: CapabilityFlags = _

Client only flag. Not used.

Client

Do not issue SIGPIPE if network failures occur (libmysqlclient only).

pub const CLIENT_TRANSACTIONS: CapabilityFlags = _

Client knows about transactions.

Server

Can send status flags in OK_Packet / EOF_Packet.

Client

Expects status flags in OK_Packet / EOF_Packet.

Note

This flag is optional in 3.23, but always set by the server since 4.0.

pub const CLIENT_RESERVED: CapabilityFlags = _

pub const CLIENT_SECURE_CONNECTION: CapabilityFlags = _

pub const CLIENT_MULTI_STATEMENTS: CapabilityFlags = _

Enable/disable multi-stmt support. Also sets CLIENT_MULTI_RESULTS. Currently not checked anywhere.

Server

Can handle multiple statements per COM_QUERY and COM_STMT_PREPARE.

Client

May send multiple statements per COM_QUERY and COM_STMT_PREPARE.

pub const CLIENT_MULTI_RESULTS: CapabilityFlags = _

Enable/disable multi-results.

Server

Can send multiple resultsets for COM_QUERY. Error if the server needs to send them and client does not support them.

Client

Can handle multiple resultsets for COM_QUERY.

Requires

CLIENT_PROTOCOL_41

pub const CLIENT_PS_MULTI_RESULTS: CapabilityFlags = _

Multi-results and OUT parameters in PS-protocol.

Server

Can send multiple resultsets for COM_STMT_EXECUTE.

Client

Can handle multiple resultsets for COM_STMT_EXECUTE.

Requires

CLIENT_PROTOCOL_41

pub const CLIENT_PLUGIN_AUTH: CapabilityFlags = _

Client supports plugin authentication.

Server

Sends extra data in Initial Handshake Packet and supports the pluggable authentication protocol.

Client

Supports authentication plugins.

Requires

CLIENT_PROTOCOL_41

pub const CLIENT_CONNECT_ATTRS: CapabilityFlags = _

Client supports connection attributes.

Server

Permits connection attributes in Protocol::HandshakeResponse41.

Client

Sends connection attributes in Protocol::HandshakeResponse41.

pub const CLIENT_PLUGIN_AUTH_LENENC_CLIENT_DATA: CapabilityFlags = _

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.

pub const CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS: CapabilityFlags = _

Don’t close the connection for a user account with expired password.

Server

Announces support for expired password extension.

Client

Can handle expired passwords.

pub const CLIENT_SESSION_TRACK: CapabilityFlags = _

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.

pub const CLIENT_DEPRECATE_EOF: CapabilityFlags = _

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.

pub const CLIENT_OPTIONAL_RESULTSET_METADATA: CapabilityFlags = _

The client can handle optional metadata information in the resultset.

pub const CLIENT_ZSTD_COMPRESSION_ALGORITHM: CapabilityFlags = _

Compression protocol extended to support zstd compression method.

This capability flag is used to send zstd compression level between client and server provided both client and server are enabled with this flag.

Server

Server sets this flag when global variable protocol-compression-algorithms has zstd in its list of supported values.

Client

Client sets this flag when it is configured to use zstd compression method.

pub const CLIENT_QUERY_ATTRIBUTES: CapabilityFlags = _

Support optional extension for query parameters into the COM_QUERY and COM_STMT_EXECUTE packets.

Server

Expects an optional part containing the query parameter set(s). Executes the query for each set of parameters or returns an error if more than 1 set of parameters is sent and the server can’t execute it.

Client

Can send the optional part containing the query parameter set(s).

pub const MULTI_FACTOR_AUTHENTICATION: CapabilityFlags = _

Support Multi factor authentication.

Server

Server sends AuthNextFactor packet after every nth factor authentication method succeeds, except the last factor authentication.

Client

Client reads AuthNextFactor packet sent by server and initiates next factor authentication method.

pub const CLIENT_PROGRESS_OBSOLETE: CapabilityFlags = _

Client or server supports progress reports within error packet.

pub const CLIENT_SSL_VERIFY_SERVER_CERT: CapabilityFlags = _

Verify server certificate. Client only flag.

Deprecated in favor of –ssl-mode.

pub const CLIENT_REMEMBER_OPTIONS: CapabilityFlags = _

Don’t reset the options after an unsuccessful connect. Client only flag.

impl CapabilityFlags

pub const fn empty() -> CapabilityFlags

Get a flags value with all bits unset.

pub const fn all() -> CapabilityFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<CapabilityFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> CapabilityFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> CapabilityFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<CapabilityFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> CapabilityFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl CapabilityFlags

pub const fn iter(&self) -> Iter<CapabilityFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<CapabilityFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for CapabilityFlags

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

Formats the value using the given formatter.

impl BitAnd for CapabilityFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = CapabilityFlags

The resulting type after applying the & operator.

impl BitAndAssign for CapabilityFlags

fn bitand_assign(&mut self, other: CapabilityFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for CapabilityFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = CapabilityFlags

The resulting type after applying the | operator.

impl BitOrAssign for CapabilityFlags

fn bitor_assign(&mut self, other: CapabilityFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for CapabilityFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = CapabilityFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for CapabilityFlags

fn bitxor_assign(&mut self, other: CapabilityFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for CapabilityFlags

fn clone(&self) -> CapabilityFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityFlags

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

Formats the value using the given formatter.

impl Default for CapabilityFlags

fn default() -> CapabilityFlags

Returns the “default value” for a type.

impl Extend<CapabilityFlags> for CapabilityFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = CapabilityFlags>,

The bitwise or (|) of the bits in each flags value.

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 Flags for CapabilityFlags

const FLAGS: &'static [Flag<CapabilityFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> CapabilityFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<CapabilityFlags> for CapabilityFlags

fn from_iter<T>(iterator: T) -> CapabilityFlags

where T: IntoIterator<Item = CapabilityFlags>,

The bitwise or (|) of the bits in each flags value.

impl Hash for CapabilityFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for CapabilityFlags

type Item = CapabilityFlags

The type of the elements being iterated over.

type IntoIter = Iter<CapabilityFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <CapabilityFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for CapabilityFlags

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

Formats the value using the given formatter.

impl Not for CapabilityFlags

fn not(self) -> CapabilityFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = CapabilityFlags

The resulting type after applying the ! operator.

impl Octal for CapabilityFlags

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

Formats the value using the given formatter.

impl PartialEq for CapabilityFlags

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

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = CapabilityFlags

The resulting type after applying the - operator.

impl SubAssign for CapabilityFlags

fn sub_assign(&mut self, other: CapabilityFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl TryFrom<u32> for CapabilityFlags

type Error = UnknownCapabilityFlags

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<CapabilityFlags, UnknownCapabilityFlags>

Performs the conversion.

impl UpperHex for CapabilityFlags

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

Formats the value using the given formatter.

impl Copy for CapabilityFlags

impl Eq for CapabilityFlags

impl StructuralPartialEq for CapabilityFlags