Struct Field 

#[non_exhaustive]
pub struct Field {
    pub name: String,
    pub description: String,
    pub fields: Vec<Field>,
    /* private fields */
}

Column of a table with generated metadata and nested fields.

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

Output only. The name of the column.

description: String

Output only. Generated description for columns and fields.

fields: Vec<Field>

Output only. Nested fields.

Implementations

impl Field

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Field::new().set_name("example");

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

Sets the value of description.

Example

let x = Field::new().set_description("example");

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

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

Sets the value of fields.

Example

let x = Field::new()
    .set_fields([
        Field::default()/* use setters */,
        Field::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Default for Field

fn default() -> Field

Returns the “default value” for a type.

impl Message for Field

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Field

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