Struct Tweak

pub struct Tweak(/* private fields */);

Represents a blinding factor/Tweak on secp256k1 curve

Contrary to a crate::SecretKey, the value 0 is also a valid tweak. Values outside secp curve order are invalid tweaks.

Implementations

impl Tweak

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.

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.

impl Tweak

pub fn new<R: Rng + ?Sized>(rng: &mut R) -> Tweak

Available on crate feature actual-rand only.

Generate a new random Tweak

pub fn from_slice(data: &[u8]) -> Result<Tweak, Error>

Converts a byte slice to a Tweak Fails if tweak is not 32 bytes or if tweak is outside secp curve order

pub fn from_inner(data: [u8; 32]) -> Result<Tweak, Error>

Converts a SECRET_KEY_SIZE(32)- array to a tweak

Trait Implementations

impl AsRef<[u8; 32]> for Tweak

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

Gets a reference to the underlying array

impl CPtr for Tweak

type Target = u8

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

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

impl Clone for Tweak

fn clone(&self) -> Tweak

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tweak

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

Formats the value using the given formatter.

impl Default for Tweak

fn default() -> Tweak

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tweak

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Tweak

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

Formats the value using the given formatter.

impl FromStr for Tweak

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Tweak, Error>

Parses a string s to return a value of this type.

impl Hash for Tweak

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I> Index<I> for Tweak

where [u8]: Index<I>,

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

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl LowerHex for Tweak

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

Formats the value using the given formatter.

impl Ord for Tweak

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

Restrict a value to a certain interval.

impl PartialEq for Tweak

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

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

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Tweak

impl Eq for Tweak

impl StructuralPartialEq for Tweak