https://github.com/ralfbiedert/interoptopus
Productive, performant, robust interop for Rust🐙
https://github.com/ralfbiedert/interoptopus
csharp ffi rust
Last synced: 2 months ago
JSON representation
Productive, performant, robust interop for Rust🐙
- Host: GitHub
- URL: https://github.com/ralfbiedert/interoptopus
- Owner: ralfbiedert
- License: mit
- Created: 2021-06-13T22:13:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2026-04-01T18:33:44.000Z (3 months ago)
- Last Synced: 2026-04-02T05:04:55.984Z (3 months ago)
- Topics: csharp, ffi, rust
- Language: Rust
- Homepage: https://interoptopus.rs
- Size: 5.24 MB
- Stars: 458
- Watchers: 8
- Forks: 42
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![crates.io-badge]][crates.io-url]
[![docs.rs-badge]][docs.rs-url]
![license-badge]
[![rust-version-badge]][rust-version-url]
[![rust-build-badge]][rust-build-url]
# Interoptopus 🐙
Productive, performant, robust interop for Rust. Pick three.
With Interoptopus you can write code like this:
```rust,ignore
#[ffi(service)]
pub struct Hello {}
#[ffi]
impl Hello {
pub fn world() -> Result { Ok(Self {}) }
}
```
and then call it from your other language like this:
```csharp
var service = Hello.World();
```
Its key features include:
- Nanosecond fast.
- Supports structs, data-enums, callbacks, services, async, idiomatic error handling, and much more ...
- Bidirectional interop, export your Rust library, or load foreign code into your Rust app.
- Painless workflow, no external tooling required.
- Polyglot core, first-class support for C#, can support any other language.
## Getting Started
Read our [documentation here](https://interoptopus.rs/docs).
## Feature Flags
Gated behind **feature flags**, these enable:
- `macros` - Proc macros such as `#[ffi]`.
- `serde` - Serde attributes on internal types.
- `tokio` - Convenience support for async services via Tokio.
- `unstable-plugins` - Experimental 'reverse interop' plugins. Not semver stable!
## Supported Languages
| Language | Backend Crate | Status |
|----------|--------------------------------------------------|---------|
| C# | [**interoptopus_csharp**][interoptopus_csharp] | ✅ |
| C | [**interoptopus_c**][interoptopus_c] | ⏯️ |
| Python | [**interoptopus_cpython**][interoptopus_cpython] | ⏯️ |
| Other | Write your own backend1 | |
✅ Tier 1 target. Active maintenance and production use. Full support of all features.
⏯️ Tier 2 target. Currently suspended, contributors wanted!
1 You can implement basic support for a new language in just a few hours, no pull request needed.
## Performance
In essence, plain calls are near-zero overhead (1-10ns), as are most structs, enums and services. If serialization is involved it scales with payload size. Using the .NET runtime as a plugin adds ~20 MB overhead.
For more details see [our benchmark numbers here](https://interoptopus.rs/benchmarks).
## Further Reading
- See our [changelog](https://interoptopus.rs/changelog).
- Read the [FAQ](https://interoptopus.rs/faq).
## Contributing
PRs are very welcome!
- Submit small bug fixes directly. Major changes should be issues first.
- New features or patterns must be materialized in the reference project and accompanied by
at least a C# interop test.
[crates.io-badge]: https://img.shields.io/crates/v/interoptopus.svg
[crates.io-url]: https://crates.io/crates/interoptopus
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[docs.rs-badge]: https://docs.rs/interoptopus/badge.svg
[docs.rs-url]: https://docs.rs/interoptopus/
[rust-version-badge]: https://img.shields.io/badge/rust-1.93%2B-blue.svg?maxAge=3600
[rust-version-url]: https://github.com/ralfbiedert/interoptopus
[rust-build-badge]: https://github.com/ralfbiedert/interoptopus/actions/workflows/rust.yml/badge.svg
[rust-build-url]: https://github.com/ralfbiedert/interoptopus/actions/workflows/rust.yml
[interoptopus_csharp]: https://crates.io/crates/interoptopus_csharp
[interoptopus_c]: https://crates.io/crates/interoptopus_backend_c
[interoptopus_cpython]: https://crates.io/crates/interoptopus_backend_cpython
[interop-cs]: https://github.com/ralfbiedert/interoptopus/blob/master/tests/tests/csharp_reference_project/Interop.cs
[reference-project]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/reference_project/src
[new-backends]: https://github.com/ralfbiedert/interoptopus/blob/master/FAQ.md#new-backends
[hello-world]: https://github.com/ralfbiedert/interoptopus/tree/master/examples/hello_world
[real-project-layout]: https://github.com/ralfbiedert/interoptopus/tree/master/examples/production_project
[backend-c]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/backend_c
[ref-functions]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/reference_project/src/functions
[ref-types]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/reference_project/src/types
[ref-constants]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/reference_project/src/constants.rs
[ref-patterns]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/reference_project/src/patterns
[ref-services]: https://github.com/ralfbiedert/interoptopus/tree/master/crates/reference_project/src/services
[csharp-benchmarks]: https://github.com/ralfbiedert/interoptopus/blob/master/tests/tests/csharp_benchmarks/RESULTS.md
[cpython-benchmarks]: https://github.com/ralfbiedert/interoptopus/blob/master/tests/tests/cpython_benchmarks/RESULTS.md
[csharp-callbacks]: https://github.com/ralfbiedert/interoptopus/blob/master/tests/tests/csharp_reference_project/Test.Pattern.Callbacks.cs
[log-crate]: https://crates.io/crates/log
[upgrade-instructions]: https://github.com/ralfbiedert/interoptopus/blob/master/UPGRADE_INSTRUCTIONS.md
[faq]: https://github.com/ralfbiedert/interoptopus/blob/master/FAQ.md