sdk-parity-check

Verify FFI export parity between Rust core and C# and Python SDK wrappers.

6|Updated Oct 29, 2024
One-click install
npx skills add https://github.com/aram-devdocs/GoudEngine --skill sdk-parity-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sdk-parity-check
Source: https://github.com/aram-devdocs/GoudEngine/tree/main/.agents/skills/sdk-parity-check
Command: npx skills add https://github.com/aram-devdocs/GoudEngine --skill sdk-parity-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that the native FFI (Foreign Function Interface) layer of the GoudEngine is accurately reflected in its C# and Python SDKs, preventing integration issues and ensuring consistent functionality across different language bindings.

Core Features & Use Cases

  • Cross-language consistency: Verifies that every FFI function has a corresponding wrapper in both C# and Python.
  • Signature matching: Checks if parameter and return types are compatible between the FFI layer and the SDKs.
  • Use Case: After adding a new graphics rendering function to the Rust core, run this Skill to confirm that the C# and Python SDKs have been updated with the correct bindings, allowing developers using those languages to immediately leverage the new feature without errors.

Quick Start

Run the bash script to check for SDK parity issues.

Frequently Asked Questions about sdk-parity-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check FFI exports match between Rust and Python or C# SDKs?

To check FFI exports, verify that every Rust function declaration has a corresponding wrapper in the C# and Python SDKs with compatible type signatures. This ensures cross-language consistency and prevents integration errors.

What is FFI parity and why do I need it for multi-language SDKs?

FFI parity ensures the native Foreign Function Interface layer is accurately reflected in language bindings. You need it to prevent integration issues and maintain consistent functionality across different SDK wrappers.

Can I verify SDK type signatures against the Rust core automatically?

Yes, you can verify SDK type signatures against the Rust core by running a bash script. It checks parameter and return types for compatibility across language boundaries to catch binding mismatches.

How do I ensure C# and Python bindings stay consistent after updating Rust?

To ensure C# and Python bindings stay consistent after updating Rust, run a parity check to confirm the SDKs have matching function declarations. This allows developers to leverage new features without errors.

Does the parity check support game development environments?

Yes, the parity check supports multi-language game development environments. It prevents integration errors by verifying matching function declarations and compatible type signatures across the Rust core and SDK wrappers.