Struct SchemaField 

#[non_exhaustive]
pub struct SchemaField {
    pub name: String,
    pub description: String,
    pub type: Type,
    pub mode: Mode,
    pub fields: Vec<SchemaField>,
    /* private fields */
}

Represents a column field within a table schema.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Required. The name of the field. Must contain only letters, numbers and underscores, with a maximum length of 767 characters, and must begin with a letter or underscore.

description: String

Optional. User friendly field description. Must be less than or equal to 1024 characters.

type: Type

Required. The type of field.

mode: Mode

Required. Additional field semantics.

fields: Vec<SchemaField>

Optional. Any nested field for complex types.

Implementations

impl SchemaField

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_mode<T: Into<Mode>>(self, v: T) -> Self

Sets the value of mode.

pub fn set_fields<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SchemaField>,

Sets the value of fields.

Trait Implementations

impl Clone for SchemaField

fn clone(&self) -> SchemaField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaField

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

Formats the value using the given formatter.

impl Default for SchemaField

fn default() -> SchemaField

Returns the “default value” for a type.

impl Message for SchemaField

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SchemaField

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