Struct CustomFieldDefinition 

pub struct CustomFieldDefinition {
    pub name: String,
    pub label: String,
    pub field_type: CustomFieldType,
    pub required: bool,
    pub options: Vec<String>,
    pub default_value: Option<String>,
    pub description: Option<String>,
    pub order: i32,
}

Definition of a custom field for a requirement type

Fields

name: String

Field name (used as key in custom_fields map)

label: String

Display label for the field

field_type: CustomFieldType

Field type

required: bool

Whether this field is required

options: Vec<String>

Options for Select field type

default_value: Option<String>

Default value (as string, converted based on field_type)

description: Option<String>

Help text / description

order: i32

Display order (lower = first)

Implementations

impl CustomFieldDefinition

pub fn text(name: impl Into<String>, label: impl Into<String>) -> Self

Creates a new text field definition

pub fn select( name: impl Into<String>, label: impl Into<String>, options: Vec<String>, ) -> Self

Creates a new select field definition

pub fn user_ref(name: impl Into<String>, label: impl Into<String>) -> Self

Creates a new user reference field definition

pub fn textarea(name: impl Into<String>, label: impl Into<String>) -> Self

Creates a new text area (multiline text) field definition

pub fn number(name: impl Into<String>, label: impl Into<String>) -> Self

Creates a new number field definition

pub fn required(self) -> Self

Sets the field as required

pub fn with_description(self, desc: impl Into<String>) -> Self

Sets the description

pub fn with_order(self, order: i32) -> Self

Sets the display order

pub fn with_default(self, value: impl Into<String>) -> Self

Sets a default value

Trait Implementations

impl Clone for CustomFieldDefinition

fn clone(&self) -> CustomFieldDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomFieldDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomFieldDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CustomFieldDefinition

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for CustomFieldDefinition

type WithoutGenerics = CustomFieldDefinition

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = CustomFieldDefinition

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.

impl StructuralPartialEq for CustomFieldDefinition