Enum OptionalMetadataFieldType

#[repr(u8)]
pub enum OptionalMetadataFieldType {
    SIGNEDNESS = 1,
    DEFAULT_CHARSET = 2,
    COLUMN_CHARSET = 3,
    COLUMN_NAME = 4,
    SET_STR_VALUE = 5,
    ENUM_STR_VALUE = 6,
    GEOMETRY_TYPE = 7,
    SIMPLE_PRIMARY_KEY = 8,
    PRIMARY_KEY_WITH_PREFIX = 9,
    ENUM_AND_SET_DEFAULT_CHARSET = 10,
    ENUM_AND_SET_COLUMN_CHARSET = 11,
    COLUMN_VISIBILITY = 12,
    VECTOR_DIMENSIONALITY = 13,
}

Enumerates types of optional metadata fields.

Variants

SIGNEDNESS = 1

UNSIGNED flag of numeric columns.

Value format

For each numeric column, a bit indicates whether the numeric colunm has unsigned flag. 1 means it is unsigned. The number of bytes needed for this is int((column_count + 7) / 8).

DEFAULT_CHARSET = 2

Character set of string columns.

This field should not appear with COLUMN_CHARSET.

Value format

• default charset as a lenght-encoded integer,
• then for every character column which charset isn’t default:
  • column index as a lenght-encoded integer,
  • column charset as a length-encoded integer.

The order is the same as the order of column_type field.

COLUMN_CHARSET = 3

Character set of string columns.

This field should not appear with DEFAULT_CHARSET.

Value format

• for every character column:
  • column charset as a length-encoded integer.

The order is the same as the order of column_type field.

COLUMN_NAME = 4

Collumn name of columns (included if binlog_row_metadata=FULL).

Value format

• for every column:
  • column name as a length-encoded string.

The order is the same as the order of column_type field.

SET_STR_VALUE = 5

Name of each variant in a SET columns.

Value format

• for every SET column:
  • number of variants as a length-encoded integer,
  • for each variant:
    • name of a variant as a length-encoded string.

The order is the same as the order of column_type field.

ENUM_STR_VALUE = 6

Name of each variant in an ENUM columns.

Value format

• for every ENUM column:
  • number of variants as a length-encoded integer,
  • for each variant:
    • name of a variant as a length-encoded string.

The order is the same as the order of column_type field.

GEOMETRY_TYPE = 7

Real type of geometry columns.

Value format

• for every geometry column:
  • geometry type as a length-encoded integer.

The order is the same as the order of column_type field.

SIMPLE_PRIMARY_KEY = 8

Primary key without prefix (included if binlog_row_metadata=FULL).

This field should not appear with PRIMARY_KEY_WITH_PREFIX.

Value format

• for every PK index column:
  • column index as a length-encoded integer.

The order is the same as the order of column_type field.

PRIMARY_KEY_WITH_PREFIX = 9

Primary key with prefix (included if binlog_row_metadata=FULL).

This field should not appear with SIMPLE_PRIMARY_KEY.

Value format

• for every PK index column:
  • column index as a length-encoded integer,
  • prefix length as a length-encoded integer

The order is the same as the order of column_type field.

Note

• prefix length is a character length, i.e. prefix byte length divided by the maximum length of a character in the correspoding charset;
• prefix length 0 means that the whole column value is used.

ENUM_AND_SET_DEFAULT_CHARSET = 10

Character set of enum and set columns.

This field should not appear with ENUM_AND_SET_COLUMN_CHARSET.

Value format

• default charset as a lenght-encoded integer,
• then for every SET or ENUM column which charset isn’t default:
  • column index as a lenght-encoded integer,
  • column charset as a length-encoded integer.

The order is the same as the order of column_type field.

ENUM_AND_SET_COLUMN_CHARSET = 11

Character set of enum and set columns.

This field should not appear with ENUM_AND_SET_DEFAULT_CHARSET.

Value format

• for every SET or ENUM column:
  • column charset as a length-encoded integer.

The order is the same as the order of column_type field.

COLUMN_VISIBILITY = 12

A flag that indicates column visibility attribute.

VECTOR_DIMENSIONALITY = 13

Vector column dimensionality.

Trait Implementations

impl Clone for OptionalMetadataFieldType

fn clone(&self) -> OptionalMetadataFieldType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionalMetadataFieldType

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

Formats the value using the given formatter.

impl Hash for OptionalMetadataFieldType

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 PartialEq for OptionalMetadataFieldType

fn eq(&self, other: &OptionalMetadataFieldType) -> 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 TryFrom<u8> for OptionalMetadataFieldType

type Error = UnknownOptionalMetadataFieldType

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for OptionalMetadataFieldType

impl Eq for OptionalMetadataFieldType

impl StructuralPartialEq for OptionalMetadataFieldType