migrate

Julia

migrate(file::EsmFile, target_version::AbstractString)

migrate(file::EsmFile, target_version::AbstractString) -> EsmFile

Migrate file from the version it declares to target_version.

Every supported step is a pure version-marker bump with no structural transform: an additive-line source (1.0.0 … <current>) advanced to the current schema version (see this file’s header). Any other version pair — a 0.x source included — throws MigrationError . Content-level changes are not performed; they are modeling decisions, not mechanical migrations.

EsmFile is immutable, so the input is necessarily left alone: a NEW EsmFile carrying the updated esm marker and every other field unchanged is returned.

Throws

• MigrationError if the file declares no version, or if the pair is not one can_migrate accepts.

Source

TypeScript

function migrate(file: EsmFile, targetVersion: string): EsmFile

Migrate an ESM file from its current schema version to the target version.

Every supported step is a pure version-marker bump with no structural transform: an additive-line source (1.0.0 … <current>) advanced to the current schema version (see the module header). Any other version pair — a 0.x source included — throws MigrationError . Content-level changes are not performed; they are modeling decisions, not mechanical migrations. The input file is never mutated; a new object with the updated esm marker is returned.

Source

Python

migrate(file: EsmFile, target_version: str) -> EsmFile

Migrate file to target_version.

Every supported step is a pure version-marker bump with no structural transform: an additive-line source (1.0.0 … <current>) advanced to the current schema version (see the module docstring). Any other version pair — a 0.x source included — raises MigrationError . Content-level changes are not performed; they are modeling decisions, not mechanical migrations.

The input file is never mutated: a new EsmFile carrying the updated marker is returned, sharing the original’s sub-objects (a shallow copy, matching TypeScript’s object spread).

Source

Rust

pub fn migrate(file: &EsmFile, target_version: &str) -> Result<EsmFile, MigrationError>

Migrate an ESM file from the version it declares to target_version.

Every supported step is a pure version-marker bump with no structural transform: an additive-line source (1.0.0 … <current>) advanced to the current schema version (see the module header). Any other version pair — a 0.x source included — yields a MigrationError . Content-level changes are not performed; they are modeling decisions, not mechanical migrations.

The input is never mutated: a clone carrying the updated esm marker and every other field unchanged is returned.

Source · Rust docs

Example (migrate)

// decay.esm is written at format 1.0.0; the current format is a newer
// 1.x, reached by a version-marker bump with no structural change.
assert_eq!(doc.esm, "1.0.0");
assert_eq!(supported_migration_targets(&doc.esm), [SCHEMA_VERSION]);
assert!(can_migrate(&doc.esm, SCHEMA_VERSION));
let migrated = migrate(&doc, SCHEMA_VERSION)?;
assert_eq!(migrated.esm, SCHEMA_VERSION);

// A 0.x document is out of reach: 1.0.0 was a clean break.
assert!(!can_migrate("0.9.0", SCHEMA_VERSION));

From docs/api/examples/rust/load.rs

Go

func Migrate(file *ESMFile, targetVersion string) (*ESMFile, error)

Migrate migrates an ESM file from its declared schema version to targetVersion.

Every supported step is a pure version-marker bump with no structural transform: an additive-line source (1.0.0 … <current>) advanced to the current schema version (see the file header). Any other version pair — a 0.x source included — returns a *MigrationError. Content-level changes are not performed; they are modeling decisions, not mechanical migrations.

The input file is never mutated: a shallow copy carrying the updated esm marker is returned. A shallow copy is exactly what the marker bump needs and exactly what the other bindings do ({...file, esm} in TypeScript) — since nothing else is written, the copy and the original may share their component maps and slices.

Source · Go docs