Struct PropertyDef 

#[non_exhaustive]
pub struct PropertyDef {
    pub name: String,
    pub label: String,
    pub kind: PropertyKind,
    pub required: bool,
    pub default: Option<Value>,
}

A property a component declares, for the editor and the save-time check.

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: String

label: String

kind: PropertyKind

required: bool

default: Option<Value>

The value used when the attachment leaves the property out.

Implementations

impl PropertyDef

pub fn new( name: impl Into<String>, label: impl Into<String>, kind: PropertyKind, ) -> Self

pub fn required(self) -> Self

pub fn default(self, value: impl Into<Value>) -> Self

Trait Implementations

impl Clone for PropertyDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyDef

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

Formats the value using the given formatter.