Struct fiberplane_models::front_matter_schemas::FrontMatterUpdateRow

#[non_exhaustive]
pub struct FrontMatterUpdateRow {
    pub new_schema: Option<FrontMatterValueSchema>,
    pub new_value: Option<Value>,
    pub delete_value: bool,
}

API Payload to update an entry to a front matter schema.

The payload is received in the context of a known (Notebook, target key) pair, and maps easily to an UpdateFrontMatterSchemaOperation

Notably, as the API will handle the call, it can fill the ceremonial data related to Operational Transform, such as getting the “old” state and “old” value that are necessary to build a valid Operation.

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.

new_schema: Option<FrontMatterValueSchema>

The new schema to use, if unspecified the operation will leave the schema untouched (so the operation is only being used to edit the associated value).

If a new schema is specified, and the data type does not match between the old and the new one, then the old value will be wiped anyway.

new_value: Option<Value>

The new value to set for the front matter entry.

If this attribute is None or null it can mean multiple things depending on the other attributes:

• if delete_value is false, this means we want to keep the current value
  • it is impossible to keep the current if the schemas are incompatible. In that case we use the default_value of the new schema (or nothing if there’s no default)
• if delete_value is true, this means we want to wipe the value from the front matter in all cases.

delete_value: bool

Switch that controls front matter value edition alongside new_value, when new_value is None.

Implementations

impl FrontMatterUpdateRow

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

Create a builder for building FrontMatterUpdateRow. On the builder, call .new_schema(...)(optional), .new_value(...)(optional), .delete_value(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FrontMatterUpdateRow.

Trait Implementations

impl Clone for FrontMatterUpdateRow

fn clone(&self) -> FrontMatterUpdateRow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrontMatterUpdateRow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrontMatterUpdateRow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FrontMatterUpdateRow

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

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 FrontMatterUpdateRow

impl StructuralPartialEq for FrontMatterUpdateRow