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.

Sign up for GitHub

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

Jump to bottom

Add must_use for mut self key manipulation methods #465

Merged
merged 2 commits into from Jun 28, 2022
Merged

Add must_use for mut self key manipulation methods #465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b86e38
Put compiler attributes below rustdocs
tcharding Jun 28, 2022
56f1843
Add must_use for mut self key manipulation methods
tcharding Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions secp256k1-sys/src/macros.rs
View file
Open in desktop
Expand Up @@ -20,26 +20,26 @@ macro_rules! impl_array_newtype {
impl Copy for $thing {}

impl $thing {
#[inline]
/// Converts the object to a raw pointer for FFI interfacing
#[inline]
pub fn as_ptr(&self) -> *const $ty {
let &$thing(ref dat) = self;
dat.as_ptr()
}

#[inline]
/// Converts the object to a mutable raw pointer for FFI interfacing
#[inline]
pub fn as_mut_ptr(&mut self) -> *mut $ty {
let &mut $thing(ref mut dat) = self;
dat.as_mut_ptr()
}

#[inline]
/// Returns the length of the object as an array
#[inline]
pub fn len(&self) -> usize { $len }

#[inline]
/// Returns whether the object as an array is empty
#[inline]
pub fn is_empty(&self) -> bool { false }
}

Expand Down
8 changes: 8 additions & 0 deletions src/key.rs
View file
Open in desktop
Expand Up @@ -243,6 +243,7 @@ impl SecretKey {

/// Negates the secret key.
#[inline]
#[must_use = "you forgot to use the negated secret key"]
pub fn negate(mut self) -> SecretKey {
unsafe {
let res = ffi::secp256k1_ec_seckey_negate(
Expand Down Expand Up @@ -272,6 +273,7 @@ impl SecretKey {
///
/// Returns an error if the resulting key would be invalid.
#[inline]
#[must_use = "you forgot to use the tweaked secret key"]
pub fn add_tweak(mut self, tweak: &Scalar) -> Result<SecretKey, Error> {
unsafe {
if ffi::secp256k1_ec_seckey_tweak_add(
Expand Down Expand Up @@ -302,6 +304,7 @@ impl SecretKey {
///
/// Returns an error if the resulting key would be invalid.
#[inline]
#[must_use = "you forgot to use the tweaked secret key"]
pub fn mul_tweak(mut self, tweak: &Scalar) -> Result<SecretKey, Error> {
unsafe {
if ffi::secp256k1_ec_seckey_tweak_mul(
Expand Down Expand Up @@ -536,6 +539,7 @@ impl PublicKey {

/// Negates the public key.
#[inline]
#[must_use = "you forgot to use the negated public key"]
pub fn negate<C: Verification>(mut self, secp: &Secp256k1<C>) -> PublicKey {
unsafe {
let res = ffi::secp256k1_ec_pubkey_negate(secp.ctx, &mut self.0);
Expand Down Expand Up @@ -566,6 +570,7 @@ impl PublicKey {
///
/// Returns an error if the resulting key would be invalid.
#[inline]
#[must_use = "you forgot to use the tweaked public key"]
pub fn add_exp_tweak<C: Verification>(
mut self,
secp: &Secp256k1<C>,
Expand Down Expand Up @@ -602,6 +607,7 @@ impl PublicKey {
///
/// Returns an error if the resulting key would be invalid.
#[inline]
#[must_use = "you forgot to use the tweaked public key"]
pub fn mul_tweak<C: Verification>(
mut self,
secp: &Secp256k1<C>,
Expand Down Expand Up @@ -971,6 +977,7 @@ impl KeyPair {
/// ```
// TODO: Add checked implementation
#[inline]
#[must_use = "you forgot to use the tweaked key pair"]
pub fn add_xonly_tweak<C: Verification>(
mut self,
secp: &Secp256k1<C>,
Expand Down Expand Up @@ -1270,6 +1277,7 @@ impl XOnlyPublicKey {
/// let tweaked = xonly.add_tweak(&secp, &tweak).expect("Improbable to fail with a randomly generated tweak");
/// # }
/// ```
#[must_use = "you forgot to use the tweaked xonly pubkey"]
pub fn add_tweak<V: Verification>(
mut self,
secp: &Secp256k1<V>,
Expand Down