Skip to main content
Cloacina Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Cloacina
  2. /
  3. API Reference
  4. /
  5. rust
  6. /
  7. cloacina
  8. /
  9. registry
  10. /
  11. Types

Types

cloacina::registry::types Rust

Data types for the workflow registry system.

This module defines the core data structures used throughout the registry, including workflow metadata, package information, and identifiers.

Structs

cloacina::registry::types::WorkflowMetadata

pub

Derives: Debug, Clone, Serialize, Deserialize, PartialEq

Metadata for a registered workflow package.

This structure contains all the descriptive information about a workflow package, stored in the workflow_packages table. It includes both user-provided metadata and system-generated information.

Examples:

use cloacina::registry::WorkflowMetadata;
use uuid::Uuid;
use chrono::Utc;

let metadata = WorkflowMetadata {
    id: Uuid::new_v4(),
    registry_id: Uuid::new_v4(),
    package_name: "analytics_pipeline".to_string(),
    version: "1.0.0".to_string(),
    description: Some("Customer analytics workflow".to_string()),
    author: Some("Data Team".to_string()),
    tasks: vec!["extract_data".to_string(), "transform_data".to_string()],
    schedules: vec!["daily_analytics".to_string()],
    created_at: Utc::now(),
    updated_at: Utc::now(),
};

Fields

Name Type Description
id WorkflowPackageId Unique identifier for this workflow package
registry_id Uuid Foreign key to the workflow_registry table
package_name String Name of the workflow package (e.g., “analytics_pipeline”)
version String Semantic version of the package (e.g., “1.0.0”)
description Option < String > Optional human-readable description
author Option < String > Optional author information
tasks Vec < String > List of task IDs included in this package
schedules Vec < String > List of schedule names defined in this package
created_at DateTime < Utc > When this package was registered
updated_at DateTime < Utc > When this package metadata was last updated

cloacina::registry::types::PackageMetadata

pub

Derives: Debug, Clone, Serialize, Deserialize

Package metadata extracted from a .cloacina file.

This structure represents the metadata embedded in the packaged workflow file itself, typically extracted during the packaging process by cloacina-ctl.

Fields

Name Type Description
package String Package name from the workflow macro
version String Version from Cargo.toml
description Option < String > Optional description
author Option < String > Optional author from Cargo.toml
build_info BuildInfo Build metadata
tasks Vec < TaskInfo > Task information
schedules Vec < ScheduleInfo > Schedule information

cloacina::registry::types::BuildInfo

pub

Derives: Debug, Clone, Serialize, Deserialize

Build information embedded in the package.

Fields

Name Type Description
rustc_version String Rust compiler version used
cloacina_version String Cloacina version used
build_timestamp DateTime < Utc > Build timestamp
target String Target architecture

cloacina::registry::types::TaskInfo

pub

Derives: Debug, Clone, Serialize, Deserialize

Basic task information from package metadata.

Fields

Name Type Description
id String Task identifier
dependencies Vec < String > Task dependencies
description Option < String > Optional task description

cloacina::registry::types::ScheduleInfo

pub

Derives: Debug, Clone, Serialize, Deserialize

Schedule information from package metadata.

Fields

Name Type Description
name String Schedule name
cron String Cron expression
workflow String Workflow to execute

cloacina::registry::types::WorkflowPackage

pub

Derives: Debug

A workflow package ready for registration.

This structure combines the extracted metadata with the raw binary data of the compiled workflow .so file.

Fields

Name Type Description
metadata PackageMetadata Metadata extracted from the package
package_data Vec < u8 > Raw binary data of the .so file

Methods

new pub 
fn new (metadata : PackageMetadata , package_data : Vec < u8 >) -> Self

Create a new workflow package from metadata and binary data.

Source 
    pub fn new(metadata: PackageMetadata, package_data: Vec<u8>) -> Self {
        Self {
            metadata,
            package_data,
        }
    }
from_file pub 
fn from_file (_path : impl AsRef < std :: path :: Path >) -> Result < Self , std :: io :: Error >

Load a workflow package from a .cloacina file.

Parameters:

Name Type Description
path - Path to the .cloacina package file

Returns:

  • Ok(WorkflowPackage) - Successfully loaded package * Err(std::io::Error) - If file operations fail

Examples:

use cloacina::registry::WorkflowPackage;

# fn example() -> Result<(), Box<dyn std::error::Error>> {
let package = WorkflowPackage::from_file("analytics.cloacina")?;
println!("Loaded package: {} v{}",
    package.metadata.package,
    package.metadata.version
);
# Ok(())
# }
Source 
    pub fn from_file(_path: impl AsRef<std::path::Path>) -> Result<Self, std::io::Error> {
        // This will be implemented to use cloacina-ctl's extraction logic
        todo!("Implement using cloacina-ctl archive extraction")
    }

cloacina::registry::types::LoadedWorkflow

pub

Derives: Debug

A loaded workflow with both metadata and binary data.

This structure is returned when retrieving a workflow from the registry, containing all the information needed to execute the workflow.

Fields

Name Type Description
metadata WorkflowMetadata Full metadata from the database
package_data Vec < u8 > Binary data from registry storage

Methods

new pub 
fn new (metadata : WorkflowMetadata , package_data : Vec < u8 >) -> Self

Create a new loaded workflow.

Source 
    pub fn new(metadata: WorkflowMetadata, package_data: Vec<u8>) -> Self {
        Self {
            metadata,
            package_data,
        }
    }
gdoc_arrow_left_alt Traits loader gdoc_arrow_right_alt