Struct FieldMetadata 

pub struct FieldMetadata<'ast> {
    pub doc: Option<&'ast str>,
    pub annotation: Annotation<'ast>,
    pub opt: bool,
    pub not_exported: bool,
    pub priority: MergePriority,
}

The metadata attached to record fields.

Fields

doc: Option<&'ast str>

The documentation of the field.

annotation: Annotation<'ast>

Type and contract annotations.

opt: bool

If the field is optional.

not_exported: bool

If the field should be skipped during serialization.

priority: MergePriority

The merge priority.

Implementations

impl FieldMetadata<'_>

pub fn new() -> Self

pub fn is_empty(&self) -> bool

Trait Implementations

impl<'ast> Clone for FieldMetadata<'ast>

fn clone(&self) -> FieldMetadata<'ast>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CloneTo for FieldMetadata<'_>

type Data<'ast> = FieldMetadata<'ast>

This is always Self, be we need associated types to make Rust understand that Self is always parametric over the 'ast lifetime. We’re using GATs to emulate higher-kinded types.

fn clone_to<'to>(data: Self::Data<'_>, dest: &'to AstAlloc) -> Self::Data<'to>

Clones owned data from the current allocator to dest.

impl<'ast> Combine<'ast> for FieldMetadata<'ast>

fn combine(alloc: &'ast AstAlloc, left: Self, right: Self) -> Self

Combine two field metadata into one. If data that can’t be combined (typically, the documentation or the type annotation) are set by both, the left one’s are kept.

impl<'ast> CombineAlloc<'ast> for FieldMetadata<'ast>

fn combine(alloc: &'ast AstAlloc, left: Self, right: Self) -> Self

Combine two field metadata into one. If data that can’t be combined (typically, the documentation or the type annotation) are set by both, the left one’s are kept.

impl<'ast> Debug for FieldMetadata<'ast>

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

Formats the value using the given formatter.

impl<'ast> Default for FieldMetadata<'ast>

fn default() -> FieldMetadata<'ast>

Returns the “default value” for a type.

impl<'ast> From<Annotation<'ast>> for FieldMetadata<'ast>

fn from(annotation: Annotation<'ast>) -> Self

Converts to this type from the input type.

impl<'ast> From<LetMetadata<'ast>> for FieldMetadata<'ast>

fn from(let_metadata: LetMetadata<'ast>) -> Self

Converts to this type from the input type.

impl<'ast> PartialEq for FieldMetadata<'ast>

fn eq(&self, other: &FieldMetadata<'ast>) -> 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<'ast> TryFrom<FieldMetadata<'ast>> for LetMetadata<'ast>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(field_metadata: FieldMetadata<'ast>) -> Result<Self, Self::Error>

Performs the conversion.

impl Allocable for FieldMetadata<'_>

impl<'ast> Eq for FieldMetadata<'ast>

impl<'ast> StructuralPartialEq for FieldMetadata<'ast>