Struct secp256k1::ffi::SharedSecret

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

Library-internal representation of an ECDH shared secret

Methods

impl SharedSecret

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 SharedSecret

pub fn new() -> SharedSecret

Create a new (zeroed) signature usable for the FFI interface

pub unsafe fn blank() -> SharedSecret

Create a new (uninitialized) signature usable for the FFI interface

Trait Implementations

impl PartialOrd<SharedSecret> for SharedSecret

fn partial_cmp(&self, other: &SharedSecret) -> 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 PartialEq<SharedSecret> for SharedSecret

fn eq(&self, other: &SharedSecret) -> 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 Copy for SharedSecret

impl Ord for SharedSecret

fn cmp(&self, other: &SharedSecret) -> 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 Eq for SharedSecret

impl Default for SharedSecret

fn default() -> Self

Returns the "default value" for a type.

impl From<SharedSecret> for SharedSecret

Creates a new shared secret from a FFI shared secret

fn from(ss: SharedSecret) -> SharedSecret

Performs the conversion.

impl Clone for SharedSecret

fn clone(&self) -> SharedSecret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Index<usize> for SharedSecret

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Range<usize>> for SharedSecret

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for SharedSecret

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for SharedSecret

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 SharedSecret

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Debug for SharedSecret

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

Formats the value using the given formatter.