Struct FieldDef 

pub struct FieldDef {
    pub name: String,
    pub optional: bool,
    pub default: Option<Value>,
}

Field definition with optional default value.

Represents a field in a schema with its name, whether it’s optional, and an optional default value.

Examples

use hedl_core::schema_version::FieldDef;
use hedl_core::Value;

// Required field
let id_field = FieldDef {
    name: "id".to_string(),
    optional: false,
    default: None,
};

// Optional field with default
let status_field = FieldDef {
    name: "status".to_string(),
    optional: true,
    default: Some(Value::String("active".to_string().into())),
};

Fields

name: String

The field name.

optional: bool

Whether the field is optional.

default: Option<Value>

Default value if the field is omitted.

Implementations

impl FieldDef

pub fn required(name: impl Into<String>) -> Self

Create a new required field definition.

Arguments

• name - The field name

Examples

use hedl_core::schema_version::FieldDef;

let field = FieldDef::required("id");
assert!(!field.optional);
assert!(field.default.is_none());

pub fn optional(name: impl Into<String>) -> Self

Create a new optional field definition.

Arguments

• name - The field name

Examples

use hedl_core::schema_version::FieldDef;

let field = FieldDef::optional("description");
assert!(field.optional);
assert!(field.default.is_none());

pub fn with_default(name: impl Into<String>, default: Value) -> Self

Create a new optional field with a default value.

Arguments

• name - The field name
• default - The default value

Examples

use hedl_core::schema_version::FieldDef;
use hedl_core::Value;

let field = FieldDef::with_default("active", Value::Bool(true));
assert!(field.optional);
assert_eq!(field.default, Some(Value::Bool(true)));

Trait Implementations

impl Clone for FieldDef

fn clone(&self) -> FieldDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDef

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

Formats the value using the given formatter.

impl PartialEq for FieldDef

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