Struct secp256k1_zkp_sys::KeyPair

#[repr(C)]
pub struct KeyPair(_);

Implementations

impl KeyPair

pub unsafe fn new() -> KeyPair

Creates an “uninitialized” FFI keypair which is zeroed out

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.

pub unsafe fn from_array_unchecked(data: [u8; 96]) -> KeyPair

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

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.

pub fn underlying_bytes(self) -> [u8; 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.

impl KeyPair

pub fn as_ptr(&self) -> *const u8

Converts the object to a raw pointer for FFI interfacing

pub fn as_mut_ptr(&mut self) -> *mut u8

Converts the object to a mutable raw pointer for FFI interfacing

pub fn len(&self) -> usize

Returns the length of the object as an array

pub fn is_empty(&self) -> bool

Returns whether the object as an array is empty

Trait Implementations

impl AsRef<[u8; 96]> for KeyPair

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

Gets a reference to the underlying array

impl CPtr for KeyPair

type Target = u8

pub fn as_c_ptr(&self) -> *const <KeyPair as CPtr>::Target

pub fn as_mut_c_ptr(&mut self) -> *mut <KeyPair as CPtr>::Target

impl Clone for KeyPair

pub fn clone(&self) -> KeyPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyPair

impl Debug for KeyPair

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

Formats the value using the given formatter.

impl Eq for KeyPair

impl Hash for KeyPair

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Index<Range<usize>> for KeyPair

type Output = [u8]

The returned type after indexing.

pub fn index(&self, index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for KeyPair

type Output = [u8]

The returned type after indexing.

pub fn index(&self, index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for KeyPair

type Output = [u8]

The returned type after indexing.

pub fn index(&self, RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for KeyPair

type Output = [u8]

The returned type after indexing.

pub fn index(&self, index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<usize> for KeyPair

type Output = u8

The returned type after indexing.

pub fn index(&self, index: usize) -> &u8

Performs the indexing (container[index]) operation.

impl Ord for KeyPair

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

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<KeyPair> for KeyPair

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<KeyPair> for KeyPair

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

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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