Struct secp256k1_sys::Keypair

source ·
#[repr(C)]
pub struct Keypair(/* private fields */);

Implementations§

source§

impl Keypair

source

pub fn cmp_fast_unstable(&self, other: &Self) -> Ordering

Like cmp::Ord but faster and with no guarantees across library versions.

The inner byte array of Self is passed across the FFI boundry, as such there are no guarantees on its layout and it is subject to change across library versions, even minor versions. For this reason comparison function implementations (e.g. Ord, PartialEq) take measures to ensure the data will remain constant (e.g., by serializing it to a guaranteed format). This means they may be slow, this function provides a faster comparison if you know that your types come from the same library version.

source

pub fn eq_fast_unstable(&self, other: &Self) -> bool

Like cmp::Eq but faster and with no guarantees across library versions.

The inner byte array of Self is passed across the FFI boundry, as such there are no guarantees on its layout and it is subject to change across library versions, even minor versions. For this reason comparison function implementations (e.g. Ord, PartialEq) take measures to ensure the data will remain constant (e.g., by serializing it to a guaranteed format). This means they may be slow, this function provides a faster equality check if you know that your types come from the same library version.

source§

impl Keypair

source

pub unsafe fn new() -> Self

Creates an “uninitialized” FFI keypair which is zeroed out

Safety

If you pass this to any FFI functions, except as an out-pointer, the result is likely to be an assertation failure and process termination.

source

pub unsafe fn from_array_unchecked(data: [c_uchar; 96]) -> Self

Create a new keypair usable for the FFI interface from raw bytes

Safety

Does not check the validity of the underlying representation. If it is invalid the result may be assertation failures (and process aborts) from the underlying library. You should not use this method except with data that you obtained from the FFI interface of the same version of this library.

source

pub fn underlying_bytes(self) -> [c_uchar; 96]

Returns the underlying FFI opaque representation of the x-only public key

You should not use this unless you really know what you are doing. It is essentially only useful for extending the FFI interface itself.

source

pub fn non_secure_erase(&mut self)

Attempts to erase the contents of the underlying array.

Note, however, that the compiler is allowed to freely copy or move the contents of this array to other places in memory. Preventing this behavior is very subtle. For more discussion on this, please see the documentation of the zeroize crate.

Trait Implementations§

source§

impl AsRef<[u8; 96]> for Keypair

source§

fn as_ref(&self) -> &[c_uchar; 96]

Gets a reference to the underlying array

source§

impl CPtr for Keypair

§

type Target = u8

source§

fn as_c_ptr(&self) -> *const Self::Target

source§

fn as_mut_c_ptr(&mut self) -> *mut Self::Target

source§

impl Clone for Keypair

source§

fn clone(&self) -> Keypair

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Keypair

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Hash for Keypair

Available on non-secp256k1_fuzz only.
source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<I> Index<I> for Keypair
where [c_uchar]: Index<I>,

§

type Output = <[u8] as Index<I>>::Output

The returned type after indexing.
source§

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl Ord for Keypair

Available on non-secp256k1_fuzz only.
source§

fn cmp(&self, other: &Keypair) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Keypair

Available on non-secp256k1_fuzz only.
source§

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for Keypair

Available on non-secp256k1_fuzz only.
source§

fn partial_cmp(&self, other: &Keypair) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Copy for Keypair

source§

impl Eq for Keypair

Available on non-secp256k1_fuzz only.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.