Enum fiberplane_models::notebooks::front_matter::FrontMatterValue

#[non_exhaustive]
pub enum FrontMatterValue {
    DateTime(FrontMatterDateTimeValue),
    DateTimeList(FrontMatterDateTimeList),
    User(FrontMatterUserValue),
    UserList(FrontMatterUserList),
    String(FrontMatterStringValue),
    StringList(FrontMatterStringList),
    Number(FrontMatterNumberValue),
    NumberList(FrontMatterNumberList),
}

Known variants of front-matter values for runtime validation.

Front matter values can hold extra type information to allow the API and the operational transform operations to validate values before storing them.

The usual pattern to use these values is to use the validate_value method of FrontMatterSchemaEntry to check if the value has the expected type:

// An existing schema to check values against
let schema = FrontMatterSchemaEntry::builder()
    .key("foo")
    .schema(FrontMatterNumberSchema::builder()
        .display_name("A number field that accepts single numbers")
        .build())
    .build();
     
// A value that came from an API boundary
let good_value_from_api = json!(42);
assert!(schema.validate_value(good_value_from_api.clone()).is_ok());

// Another value (that has the wrong type)
let bad_value_from_api = json!("2022-10-08T13:29:00.78Z");
assert!(schema.validate_value(bad_value_from_api).is_err());

This can be used to validate the obtained value format.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DateTime(FrontMatterDateTimeValue)

A timestamp front matter value

DateTimeList(FrontMatterDateTimeList)

A list-of-timestamps front matter value

User(FrontMatterUserValue)

A user front matter value

UserList(FrontMatterUserList)

A list-of-users front matter value

String(FrontMatterStringValue)

A string front matter value

StringList(FrontMatterStringList)

A list-of-strings front matter value

Number(FrontMatterNumberValue)

A number front matter value

NumberList(FrontMatterNumberList)

A list-of-numbers front matter value

Implementations

impl FrontMatterValue

pub fn get_type(&self) -> &'static str

Get a string description of the type of the value

Trait Implementations

impl Clone for FrontMatterValue

fn clone(&self) -> FrontMatterValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrontMatterValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrontMatterValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FrontMatterValue

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

Formats the value using the given formatter.

impl From<FrontMatterDateTimeList> for FrontMatterValue

fn from(v: FrontMatterDateTimeList) -> Self

Converts to this type from the input type.

impl From<FrontMatterDateTimeValue> for FrontMatterValue

fn from(v: FrontMatterDateTimeValue) -> Self

Converts to this type from the input type.

impl From<FrontMatterNumberList> for FrontMatterValue

fn from(v: FrontMatterNumberList) -> Self

Converts to this type from the input type.

impl From<FrontMatterNumberValue> for FrontMatterValue

fn from(v: FrontMatterNumberValue) -> Self

Converts to this type from the input type.

impl From<FrontMatterStringList> for FrontMatterValue

fn from(v: FrontMatterStringList) -> Self

Converts to this type from the input type.

impl From<FrontMatterStringValue> for FrontMatterValue

fn from(v: FrontMatterStringValue) -> Self

Converts to this type from the input type.

impl From<FrontMatterUserList> for FrontMatterValue

fn from(v: FrontMatterUserList) -> Self

Converts to this type from the input type.

impl From<FrontMatterUserValue> for FrontMatterValue

fn from(v: FrontMatterUserValue) -> Self

Converts to this type from the input type.

impl From<Value> for FrontMatterValue

fn from(value: Value) -> Self

Converts to this type from the input type.

impl PartialEq for FrontMatterValue

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for FrontMatterValue

type Error = FrontMatterValidationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FrontMatterValue

impl StructuralPartialEq for FrontMatterValue