Struct FieldDescriptor 

#[non_exhaustive]
pub struct FieldDescriptor {
    pub name: &'static str,
    pub label: &'static str,
    pub format: FieldFormat,
}

Descriptor for one field of a typed document. Carries enough metadata for a renderer to display the field with its proper label, in proper order, with a format hint dispatched off FieldFormat.

#[non_exhaustive] so additional fields (e.g. nullability hints, deprecation markers) can land additively without breaking external consumers that struct-literal-construct.

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: &'static str

The proto3 field name (snake_case) — matches the JSON key used when the message round-trips through serde.

label: &'static str

Human-readable display label — typically TitleCase or space-separated for multi-word names.

format: FieldFormat

Rendering hint.

Implementations

impl FieldDescriptor

pub fn new(name: &'static str, label: &'static str, format: FieldFormat) -> Self

Construct a FieldDescriptor. Use this from external crates that register their own types — direct struct-literal construction is reserved for peat-schema itself so future field additions stay non-breaking.

Trait Implementations

impl Clone for FieldDescriptor

fn clone(&self) -> FieldDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDescriptor

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

Formats the value using the given formatter.