Skip to main content

FieldTransform

Enum FieldTransform 

Source
pub enum FieldTransform {
    RenameField {
        old_key: String,
        new_key: String,
    },
    DropField {
        key: String,
    },
    AddField {
        key: String,
        value: Value,
    },
    KeepFields {
        keys: Vec<String>,
    },
    ApplyExpr {
        key: String,
        expr: Expr,
        inverse: Option<Expr>,
        coercion_class: CoercionClass,
    },
    PathTransform {
        path: Vec<String>,
        inner: Box<Self>,
    },
    ComputeField {
        target_key: String,
        expr: Expr,
        inverse: Option<Expr>,
        coercion_class: CoercionClass,
    },
    Case {
        branches: Vec<CaseBranch>,
    },
    MapReferences {
        field: String,
        rename_map: HashMap<String, Option<String>>,
    },
}
Expand description

A value-level transformation on a node’s extra_fields.

These are applied during wtype_restrict after structural operations (anchor remapping, vertex survival). They enable the instance pipeline to handle value-dependent migrations (attribute renames, drops, value transforms) that go beyond pure structural schema changes.

Variants§

§

RenameField

Rename a field key: old_keynew_key.

Fields

§old_key: String

The current field name.

§new_key: String

The new field name.

§

DropField

Drop a field by key.

Fields

§key: String

The field to remove.

§

AddField

Add a field with a constant default value.

Fields

§key: String

The field name to add.

§value: Value

The default value.

§

KeepFields

Keep only the specified fields (all others are dropped).

Fields

§keys: Vec<String>

The field names to retain.

§

ApplyExpr

Apply an expression to a field’s value, storing the result.

Fields

§key: String

The field whose value is transformed.

§expr: Expr

The expression to evaluate (receives the field value as input).

§inverse: Option<Expr>

Optional inverse expression for round-tripping.

§coercion_class: CoercionClass

Round-trip classification of this transformation.

§

PathTransform

Apply a field transform at a nested path within the Value tree.

The path is a sequence of string keys navigating through nested Value::Unknown (object) structures. The inner transform is applied to the extra_fields map at the resolved path.

This generalizes flat field transforms to operate on the full Value algebra. A PathTransform with an empty path is equivalent to applying the inner transform directly.

Categorically, this is the action of a path functor on the endomorphism algebra of field transforms; it lifts a transform from a leaf to an inner node of the Value tree.

Fields

§path: Vec<String>

Path to navigate (e.g., vec!["attrs"] for nested attrs objects).

§inner: Box<Self>

The transform to apply at the resolved path.

§

ComputeField

Compute a field value from an expression with access to the full fiber over the parent vertex.

Unlike ApplyExpr which binds a single field, ComputeField binds all extra_fields, nested attrs, AND scalar values from immediate child nodes (the dependent-sum projection) as variables, evaluates the expression, and stores the result in the target field.

This means ComputeField can access any scalar property of the parent object, whether it was parsed as an extra field or as a schema-defined child vertex (e.g., a string field with a "format" annotation like "at-uri"). Computed results are always written to extra_fields, making them available to subsequent transforms and to to_json serialization (where extra_fields overwrite child values with the same key).

Computed fields are classified by coercion_class:

  • Iso: the computation is invertible via inverse; the lens law PutGet holds for modifications to the computed field.
  • Opaque: no inverse exists; the complement stores the entire original value. Modifications to the computed field in the view are not independently round-trippable. This is analogous to SQL computed columns: the lens law holds for the independent (non-derived) components of the view, and the derived components are re-computed deterministically.

This enables template name computation like target_key: “name”, expr: (concat "h" (int_to_str attrs.level)) which computes “h1”, “h2”, etc. from the level attribute, as well as AT-URI decomposition where the repo field is a schema-defined child vertex.

Fields

§target_key: String

The field to store the computed result in.

§expr: Expr

The expression, with all extra_fields bound as variables.

§inverse: Option<Expr>

Optional inverse expression for round-tripping.

§coercion_class: CoercionClass

Round-trip classification of this transformation.

§

Case

Case analysis on node values: the coproduct eliminator for the field transform algebra.

Each branch is a (predicate, transforms) pair. Branches are evaluated in order with the node’s extra_fields (and nested attrs.* keys) bound as expression variables. The first branch whose predicate evaluates to true has its transforms applied. If no branch matches, the node passes through unchanged.

This is the dependent function space lift of field transforms: Π(x : Value). FieldTransform, a transform that depends on the runtime value of the node, not just its schema vertex. It composes naturally with all other transform variants (including nesting inside PathTransform).

Use cases:

  • matchAttrs: “if level == 1 then rename to h1, if level == 2 then rename to h2”, where each heading level is a branch.
  • Conditional attribute injection: “if list == 'ordered' then add type: ol, else add type: ul”.

Fields

§branches: Vec<CaseBranch>

Ordered branches: first matching predicate wins.

§

MapReferences

Update string values that reference vertex names.

When vertices are renamed or dropped during migration, string fields that reference those vertices by name must be updated to reflect the new names. This is the functorial action of the vertex rename map on the name-reference algebra.

For each field value:

  • If the value is a Value::Str matching a key in rename_map, it is replaced with the mapped value (or removed if mapped to None).
  • If the value is a Value::List, each string element is checked and the list is rebuilt with renames applied and drops removed.

This handles parent reference arrays, cross-annotation links, and any other string fields that carry vertex identity.

Fields

§field: String

The field containing references (e.g., “parents”).

§rename_map: HashMap<String, Option<String>>

Map from old name to new name (None = remove the reference).

Implementations§

Source§

impl FieldTransform

Source

pub fn coercion_class(&self) -> CoercionClass

Compute the coercion class of this field transform.

The class describes the round-trip properties: whether the transform is lossless (Iso), has a left inverse (Retraction), is a deterministic derivation (Projection), or has no structural round-trip property (Opaque).

Trait Implementations§

Source§

impl Clone for FieldTransform

Source§

fn clone(&self) -> FieldTransform

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldTransform

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for FieldTransform

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for FieldTransform

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.