Struct DataField 

pub struct DataField {
    pub name: Text,
    pub docs: Option<Text>,
    pub typing: Type,
    pub optional: bool,
    pub flattened: bool,
}

A field in a DataType.

Fields

name: Text

Name of the field.

docs: Option<Text>

Markdown-formatted documentation of the field.

typing: Type

Type of the field.

optional: bool

True if the field is semantically optional.

flattened: bool

True if the field is semantically flattened.

This property has no effect on the encoding, decoding, or in-language representation of a field; it’s an informational marker that some marshallers (like JSON) may use to enable compatibility between coda-defined data and legacy systems.

Trait Implementations

impl Clone for DataField

fn clone(&self) -> DataField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataField

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

Formats the value using the given formatter.

impl Decodable for DataField

fn decode( &mut self, reader: &mut (impl ReadsDecodable + ?Sized), header: Option<DataHeader>, ) -> Result<(), CodecError>

Decodes data with header from reader into this thing.

fn ensure_header( header: Option<DataHeader>, supported_ordinals: &[u8], ) -> Result<DataHeader, CodecError>

Returns Ok(header) iff header exists and matches one of suppported_ordinals.

fn ensure_no_header(header: Option<DataHeader>) -> Result<(), CodecError>

Returns Ok(()) iff header is None.

impl Default for DataField

fn default() -> DataField

Returns the “default value” for a type.

impl Encodable for DataField

const FORMAT: Format

This thing’s Format.

fn encode( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

Encodes this thing’s data into writer without encoding a DataHeader.

fn encode_header( &self, writer: &mut (impl WritesEncodable + ?Sized), ) -> Result<(), CodecError>

Encodes this thing’s data header into writer.

impl PartialEq for DataField

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