milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Clarified conversions between `Parity` and integers

This commit is contained in:
Martin Habovstiak 2022-02-09 15:33:25 +01:00
parent ecb62612b5
commit 705c9cfbc1
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/key.rs
View File

@ -1154,22 +1154,32 @@ pub enum Parity {
} }
impl Parity { impl Parity {
/// Converts parity into a integer (byte) value. /// Converts parity into an integer (byte) value.
///
/// This returns `0` for even parity and `1` for odd parity.
pub fn to_u8(self) -> u8 { pub fn to_u8(self) -> u8 {
self as u8 self as u8
} }
/// Converts parity into a integer value. /// Converts parity into an integer value.
///
/// This returns `0` for even parity and `1` for odd parity.
pub fn to_i32(self) -> i32 { pub fn to_i32(self) -> i32 {
self as i32 self as i32
} }
/// Constructs a [`Parity`] from a byte. /// Constructs a [`Parity`] from a byte.
///
/// The only allowed values are `0` meaning even parity and `1` meaning odd.
/// Other values result in error being returned.
pub fn from_u8(parity: u8) -> Result<Parity, Error> { pub fn from_u8(parity: u8) -> Result<Parity, Error> {
Parity::from_i32(parity as i32) Parity::from_i32(parity.into())
} }
/// Constructs a [`Parity`] from a signed integer. /// Constructs a [`Parity`] from a signed integer.
///
/// The only allowed values are `0` meaning even parity and `1` meaning odd.
/// Other values result in error being returned.
pub fn from_i32(parity: i32) -> Result<Parity, Error> { pub fn from_i32(parity: i32) -> Result<Parity, Error> {
match parity { match parity {
0 => Ok(Parity::Even), 0 => Ok(Parity::Even),
@ -1181,7 +1191,9 @@ impl Parity {
impl From<i32> for Parity { impl From<i32> for Parity {
/// Please note, this method is deprecated and will be removed in an upcoming release, it /// Please note, this method is deprecated and will be removed in an upcoming release, it
/// is not equivalent to `from_u32()`, it is better to use `Parity::from_u32`. /// is **not** equivalent to `from_u32()`, it is better to use `Parity::from_u32`.
///
/// This method returns same parity as the parity of input integer.
fn from(parity: i32) -> Parity { fn from(parity: i32) -> Parity {
if parity % 2 == 0 { if parity % 2 == 0 {
Parity::Even Parity::Even
@ -1191,12 +1203,14 @@ impl From<i32> for Parity {
} }
} }
/// The conversion returns `0` for even parity and `1` for odd.
impl From<Parity> for i32 { impl From<Parity> for i32 {
fn from(parity: Parity) -> i32 { fn from(parity: Parity) -> i32 {
parity.to_i32() parity.to_i32()
} }
} }
/// Returns even parity if the operands are equal, odd otherwise.
impl BitXor for Parity { impl BitXor for Parity {
type Output = Parity; type Output = Parity;
@ -1210,6 +1224,7 @@ impl BitXor for Parity {
} }
} }
/// The parity is serialized as `i32` - `0` for even, `1` for odd.
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))] #[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
impl ::serde::Serialize for Parity { impl ::serde::Serialize for Parity {
@ -1218,6 +1233,7 @@ impl ::serde::Serialize for Parity {
} }
} }
/// The parity is deserialized as `i32` - `0` for even, `1` for odd.
#[cfg(feature = "serde")] #[cfg(feature = "serde")]
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))] #[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
impl<'de> ::serde::Deserialize<'de> for Parity { impl<'de> ::serde::Deserialize<'de> for Parity {