View on GitHub
MigrationStep
public struct MigrationStep : Sendable, Identifiable, Equatable, Hashable, CustomStringConvertibleDescribes a single step in a migration pipeline.
MigrationStep is a lightweight value type that provides identification and
display metadata for a migration step. Each migration module defines its own
steps as static properties via extensions.
The id property provides a stable, non-localizable identifier for programmatic
checks (e.g., UI state comparisons), while description is a human-readable,
display-only field that can be freely translated.
Defining Custom Steps
Migration modules extend MigrationStep with their own step constants:
extension MigrationStep {
static let importLegacyData = MigrationStep(id: "importLegacyData", description: "Import legacy data")
static let migrateCredentials = MigrationStep(id: "migrateCredentials", description: "Migrate credentials")
static let cleanup = MigrationStep(id: "cleanup", description: "Cleanup legacy data")
}
Usage
Steps are passed as associated values in MigrationProgress events:
case .inProgress(let step, let current, let total):
print("Step \(current)/\(total): \(step.description)")
See also
MigrationProgress
-
A stable, non-localizable identifier for the step.
Use this for programmatic checks (e.g.,
if step.id == "importLegacyData")Declaration
Swift
public let id: String -
A human-readable description of the step.
Used in progress reporting, log messages, and UI display. Should be a short, descriptive phrase such as
"Import legacy data"or"Migrate credentials".Declaration
Swift
public let description: String -
Creates a new migration step with the given identifier and description.
Declaration
Swift
public init(id: String, description: String)Parameters
idA stable, non-localizable identifier for programmatic use.
descriptionA human-readable description of the step.
-
Declaration
Swift
public static func == (lhs: MigrationStep, rhs: MigrationStep) -> Bool -
Declaration
Swift
public func hash(into hasher: inout Hasher)