Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename ComponentInterface? #2315

Open
bendk opened this issue Nov 15, 2024 · 0 comments
Open

Rename ComponentInterface? #2315

bendk opened this issue Nov 15, 2024 · 0 comments

Comments

@bendk
Copy link
Contributor

bendk commented Nov 15, 2024

I feel like this name is pretty opaque, unless you know about the history of UniFFI and the Mozilla Rust Components strategy. It's docstring says it's the "main public API", so we should have a nice name for it.

Maybe we could name it something like CrateInterface, LibraryInterface, ModuleInterface. I see people using these terms more often than "Component" to describe the thing they're using UniFFI to generate bindings for. CrateInterface doesn't have a great ring to it, but it makes it clear that it's handling 1 crate in a multi-crate setup.

Maybe we could lean into compiler terminology and call it an "IR", since it's an intermediate representation between the Rust code and the generated bindings.

We could also keep it ComponentInterface. Is this something that's confused/bothered others, or is it just me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant