Struct FieldMetadata 

pub struct FieldMetadata {

    pub hidden: bool,
    pub internal: bool,
    pub sensitive: bool,
    pub readonly: bool,
    pub writeonly: bool,
    pub input_only: bool,
    pub output_only: bool,
    pub omit_from_output: bool,
    pub omit_from_input: bool,
    pub deprecated: Option<DeprecationInfo>,
    pub label: Option<String>,
    pub description: Option<String>,
    pub placeholder: Option<String>,
    pub examples: Vec<String>,
    pub see_also: Vec<String>,
    pub since: Option<String>,
    pub alias: Option<String>,
    pub serialized_name: Option<String>,
    pub order: Option<i32>,
    pub default_value: Option<String>,
    pub group: Option<String>,
    pub format: Option<String>,
    pub input_type: Option<String>,
    pub max_width: Option<u32>,
    pub multiline: bool,
    pub rich_text: bool,
}

Comprehensive metadata for a field controlling visibility, deprecation, and API behavior.

This can be specified via documentation comments or attributes:

model User {
    /// @hidden
    internal_id   String

    /// @deprecated Use `newEmail` instead
    /// @since 1.0.0
    oldEmail      String?

    /// @sensitive
    /// @writeonly
    password      String

    /// @readonly
    /// @example "2024-01-15T10:30:00Z"
    createdAt     DateTime

    /// @label "Email Address"
    /// @placeholder "user@example.com"
    email         String @validate.email
}

Fields

hidden: bool

Field is hidden from public API/documentation.

internal: bool

Field is internal (may be exposed in admin APIs).

sensitive: bool

Field contains sensitive data (should be masked in logs).

readonly: bool

Field is read-only (cannot be set via API).

writeonly: bool

Field is write-only (not returned in responses, e.g., passwords).

input_only: bool

Field is only valid for input (create/update).

output_only: bool

Field is only valid for output (responses).

omit_from_output: bool

Omit this field from API responses entirely.

omit_from_input: bool

Omit this field from input schemas.

deprecated: Option<DeprecationInfo>

Field is deprecated.

label: Option<String>

Human-readable label for the field.

description: Option<String>

Description override (if different from doc comment).

placeholder: Option<String>

Placeholder text for input fields.

examples: Vec<String>

Example values.

see_also: Vec<String>

Related fields or documentation references.

since: Option<String>

Version when the field was introduced.

alias: Option<String>

Alias name for serialization.

serialized_name: Option<String>

Override the serialized field name.

order: Option<i32>

Field order hint for serialization.

default_value: Option<String>

Default value for serialization (if missing).

group: Option<String>

Field group/section for UI organization.

format: Option<String>

Display format hint (e.g., “date”, “currency”, “percent”).

input_type: Option<String>

Input type hint (e.g., “textarea”, “select”, “radio”).

max_width: Option<u32>

Maximum display width.

multiline: bool

Field should be displayed as multiline.

rich_text: bool

Rich text/HTML allowed.

Implementations

impl FieldMetadata

pub fn new() -> FieldMetadata

Create empty field metadata.

pub fn is_hidden(&self) -> bool

Check if field should be excluded from public documentation.

pub fn should_omit_from_output(&self) -> bool

Check if field should be excluded from API responses.

pub fn should_omit_from_input(&self) -> bool

Check if field should be excluded from API input.

pub fn is_deprecated(&self) -> bool

Check if field is deprecated.

pub fn deprecation_message(&self) -> Option<&str>

Get deprecation message if deprecated.

pub fn is_sensitive(&self) -> bool

Check if field contains sensitive data.

pub fn display_label(&self) -> Option<&str>

Get the display label (or None if not set).

pub fn get_examples(&self) -> &[String]

Get all examples.

pub fn from_tags(tags: &[DocTag]) -> FieldMetadata

Parse metadata from a list of doc tags.

Trait Implementations

impl Clone for FieldMetadata

fn clone(&self) -> FieldMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldMetadata

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

Formats the value using the given formatter.

impl Default for FieldMetadata

fn default() -> FieldMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldMetadata

fn deserialize<__D>( __deserializer: __D, ) -> Result<FieldMetadata, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldMetadata

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldMetadata