Struct fiberplane_models::front_matter_schemas::FrontMatterStringSchema

#[non_exhaustive]
pub struct FrontMatterStringSchema {
    pub display_name: String,
    pub icon_name: Option<String>,
    pub multiple: bool,
    pub allow_extra_values: bool,
    pub options: Option<Vec<FrontMatterStringValue>>,
    pub default_value: Option<FrontMatterStringValue>,
}

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.

display_name: String

icon_name: Option<String>

multiple: bool

Whether the field can have multiple values

allow_extra_values: bool

options: Option<Vec<FrontMatterStringValue>>

The list of valid “pre-filled” options one can choose for the field.

There is a functional difference between None and Some(Vec::new()):

• When options.is_none(), that means the current number field should not propose pre-filled values at all: this front matter field is a freeform field
• When options == Some(Vec::new()) (arguably with allow_extra_values being true), that means that the field is supposed to be a “choose value from an enumerated list”-kind of field, but without any pre-existing values being present.

The difference of intent between those two cases can be used on the front-end side to decide how to render the front matter cell

default_value: Option<FrontMatterStringValue>

Implementations

impl FrontMatterStringSchema

pub fn validate_value( &self, value: Value ) -> Result<FrontMatterValue, FrontMatterValidationError>

pub fn validate_front_matter_value( &self, value: &FrontMatterValue ) -> Result<(), FrontMatterValidationError>

impl FrontMatterStringSchema

pub fn builder() -> FrontMatterStringSchemaBuilder<((), (), (), (), (), ())>

Create a builder for building FrontMatterStringSchema. On the builder, call .display_name(...)(optional), .icon_name(...)(optional), .multiple(...)(optional), .allow_extra_values(...)(optional), .options(...)(optional), .default_value(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FrontMatterStringSchema.

Trait Implementations

impl Clone for FrontMatterStringSchema

fn clone(&self) -> FrontMatterStringSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrontMatterStringSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrontMatterStringSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FrontMatterStringSchema> for FrontMatterValueSchema

fn from(v: FrontMatterStringSchema) -> Self

Converts to this type from the input type.

impl PartialEq for FrontMatterStringSchema

fn eq(&self, other: &FrontMatterStringSchema) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FrontMatterStringSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FrontMatterStringSchema

impl StructuralPartialEq for FrontMatterStringSchema