Struct fiberplane_models::notebooks::operations::UpdateFrontMatterSchemaOperation

#[non_exhaustive]
pub struct UpdateFrontMatterSchemaOperation {
    pub key: String,
    pub old_schema: FrontMatterValueSchema,
    pub old_value: Option<FrontMatterValue>,
    pub new_schema: Option<FrontMatterValueSchema>,
    pub new_value: Option<FrontMatterValue>,
    pub delete_value: bool,
}

Changes the expected schema of a front matter key in a notebook and/or the value attached to a schema

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.

key: String

The key of the front matter schema to update.

old_schema: FrontMatterValueSchema

The previous schema used for that front matter key. The old value is used to make consistency checks, as well as revert the operation.

old_value: Option<FrontMatterValue>

The previous value for that front matter key. It is used for consistency checks, as well as making reverting operations possible.

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<FrontMatterValue>

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 old_value
  • it is impossible to keep the old_value 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 UpdateFrontMatterSchemaOperation

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

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

Trait Implementations

impl Clone for UpdateFrontMatterSchemaOperation

fn clone(&self) -> UpdateFrontMatterSchemaOperation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateFrontMatterSchemaOperation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpdateFrontMatterSchemaOperation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UpdateFrontMatterSchemaOperation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateFrontMatterSchemaOperation