Skip to content

try_sign_digest() is confusing. #2487

Description

@Firstyear

As of 3.0.0 the try_sign_digest method is now confusing enough to be unusable.

Previously in 2.x try_sign_digest took a Digest output for signing per https://docs.rs/signature/2.3.0-pre.7/signature/trait.DigestSigner.html

However in 3.x this now takes an fn mut, and it's not clear how this works. To make matters worse the doc comments are practically identical. This leads to update errors such as:

error[E0277]: expected a `Fn(&mut _)` closure, found `sha2::Sha256`
    --> src/lib.rs:1010:30
     |
1010 |             .try_sign_digest(digest)
     |              --------------- ^^^^^^ expected an `Fn(&mut _)` closure, found `sha2::Sha256`
     |              |
     |              required by a bound introduced by this call
     |
     = help: the trait `for<'a> Fn(&'a mut _)` is not implemented for `sha2::Sha256`
note: required by a bound in `try_sign_digest`
    --> /Users/william/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/signature-3.0.0/src/signer.rs:110:27
     |
 110 |     fn try_sign_digest<F: Fn(&mut D) -> Result<(), Error>>(&self, f: F) -> Result<S, Error>;
     |                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ required by this bound in `DigestSigner::try_sign_digest`

But there is no clear or actionable method to proceed as there is no way to pass the digest to this function.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions