Rename FFI error types to avoid naming conflicts#830
Merged
spacebear21 merged 2 commits intopayjoin:masterfrom Jul 1, 2025
Merged
Rename FFI error types to avoid naming conflicts#830spacebear21 merged 2 commits intopayjoin:masterfrom
spacebear21 merged 2 commits intopayjoin:masterfrom
Conversation
Collaborator
Pull Request Test Coverage Report for Build 16005924185Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
Contributor
|
This looks great! Would it make sense to add a brief note in the type doc comments that these names are shaped partly by FFI constraints? might help future contributors understand the reason behind choices like |
arminsabouri
approved these changes
Jul 1, 2025
Collaborator
arminsabouri
left a comment
arminsabouri
left a comment
There was a problem hiding this comment.
CodeACK. Justification for code change makes sense to me.
Small typos in the commit message
- is areserved => are reserved
- importedas
Comment on lines
-160
to
+163
| pub fn save<P>(&self, persister: &P) -> Result<InitializedTransitionOutcome, ReceiverPersistedError> | ||
| pub fn save<P>( | ||
| &self, | ||
| persister: &P, | ||
| ) -> Result<InitializedTransitionOutcome, ReceiverPersistedError> |
Collaborator
There was a problem hiding this comment.
Non blocking error. Just noticed that this is a pure fmt change. Probably bc we dont run fmt --check on ci for this crate.
The name `Error` causes conflicts in other languages where `Error` is a reserved keyword. And since uniffi doesn't support namespacing per mozilla/uniffi-rs#1849, this would be imported as `payjoin::Error` for implementers downstream, which is ambiguous. Renaming to `ReceiverError` fixes both of these issues.
"Error" gets replaced by "Exception" in uniffi-dart to respect dart conventions, causing issues. Since this isn't a struct native to rust-payjoin and not an actual `Error`, the easy fix is to rename it.
spacebear21
force-pushed
the
ffi-error-fixes
branch
from
8719b70 to
dd70c9f
Compare
Collaborator
Author
|
Corrected the typos, thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The first commit renames receive::Error to ReceiverError to avoid conflicts in languages where Error is a reserved keyword.
The second commit renames TerminalError to TerminalErr as a workaround to a quirk in uniffi-dart (see commit message for more detail)