Struct breez_sdk_liquid::bitcoin::util::key::secp256k1::ffi::XOnlyPublicKey

#[repr(C)]
pub struct XOnlyPublicKey(/* private fields */);

Implementations

impl XOnlyPublicKey

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

impl XOnlyPublicKey

pub unsafe fn new() -> XOnlyPublicKey

Creates an “uninitialized” FFI x-only public key 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.

pub unsafe fn from_array_unchecked(data: [u8; 64]) -> XOnlyPublicKey

Create a new x-only public key 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.

pub fn underlying_bytes(self) -> [u8; 64]

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.

Trait Implementations

impl AsRef<[u8; 64]> for XOnlyPublicKey

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

Gets a reference to the underlying array

impl CPtr for XOnlyPublicKey

type Target = u8

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

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

impl Clone for XOnlyPublicKey

fn clone(&self) -> XOnlyPublicKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XOnlyPublicKey

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

Formats the value using the given formatter.

impl From<XOnlyPublicKey> for XOnlyPublicKey

Creates a new Schnorr public key from a FFI x-only public key.

fn from(pk: XOnlyPublicKey) -> XOnlyPublicKey

Converts to this type from the input type.

impl Hash for XOnlyPublicKey

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<Range<usize>> for XOnlyPublicKey

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for XOnlyPublicKey

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for XOnlyPublicKey

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for XOnlyPublicKey

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for XOnlyPublicKey

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Ord for XOnlyPublicKey

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for XOnlyPublicKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for XOnlyPublicKey

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for XOnlyPublicKey

impl Eq for XOnlyPublicKey