Struct secp256k1_sys::PublicKey

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

Library-internal representation of a Secp256k1 public key

Methods

impl PublicKey

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

Converts the object to a raw pointer for FFI interfacing

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

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

impl PublicKey

pub unsafe fn new() -> Self

Creates an "uninitialized" FFI public key 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: [c_uchar; 64]) -> Self

Create a new public key 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) -> [c_uchar; 64]

Returns the underlying FFI opaque representation of the 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.

Trait Implementations

impl CPtr for PublicKey

type Target = c_uchar

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

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

impl AsRef<[u8; 64]> for PublicKey

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

Gets a reference to the underlying array

impl Ord for PublicKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<PublicKey> for PublicKey

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<PublicKey> for PublicKey

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for PublicKey

impl Copy for PublicKey

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl Index<usize> for PublicKey

type Output = c_uchar

The returned type after indexing.

fn index(&self, index: usize) -> &c_uchar

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for PublicKey

type Output = [c_uchar]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for PublicKey

type Output = [c_uchar]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for PublicKey

type Output = [c_uchar]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for PublicKey

type Output = [c_uchar]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[c_uchar]

Performs the indexing (container[index]) operation.

impl Hash for PublicKey

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].