-
Notifications
You must be signed in to change notification settings - Fork 41
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
(MINOR) Move crate-level functions for creating signers to new public create_signer
mod
#72
Conversation
Codecov Report
@@ Coverage Diff @@
## main #72 +/- ##
==========================================
- Coverage 73.43% 73.42% -0.02%
==========================================
Files 64 64
Lines 13279 13279
==========================================
- Hits 9752 9750 -2
- Misses 3527 3529 +2
Continue to review full report at Codecov.
|
We are currently not documenting anything behind a feature, because that is the default used when publishing via cargo docs. To fix that we need to add this to the c2pa.rs Cargo.toml file:
If we make this change, do we still need this PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm ok with this. I would be cleaner if Signer was a struct and these were constructor methods on it, but since Signer is a trait, this makes sense.
@gpeacock agreed that this would be cleaner if we could make these static methods on |
…ync_sign * 'main' of https://github.com/contentauth/c2pa-rs: Adds an add_validation_status method to Ingredient (#68) Prepare 0.8.1 release (IGNORE) Disallow overlapping publish runs (#78) Use rsa crate for RSA-PSS verification in Wasm (#77) Prepare 0.8.0 release Add a new API to provide access to COSE signing logic for external signers (#75) (MINOR) Move crate-level functions for creating signers to new public `create_signer` mod (#72) Prepare 0.7.2 release Fix broken documentation build (#74) Prepare 0.7.1 release Configure docs.rs to include feature-gated items (#73) Update XMP Toolkit to 0.5.0 (#71) # Conflicts: # sdk/Cargo.toml # sdk/src/cose_sign.rs
Changes in this pull request
Turns out it is legal in Rust to publicly export a function as a top-level entity in a crate, but such a function does not appear in the documentation for the crate.For that reason, we're moving theget_signer
andget_signer_from_files
functions into a newcreate_signer
module.(Update: This turned out to be an incorrect assumption on my part, but we've decided to make this change anyway because the docs are easier to comprehend in the new format.)
Checklist
TO DO
items (or similar) have been entered as GitHub issues and the link to that issue has been included in a comment.