milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Add docs to new public API

This commit is contained in:
Thomas Eizinger 2018-06-06 13:01:28 +08:00
parent f13cdfa8a4
commit 20222d50c9
1 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/lib.rs
View File

@ -373,12 +373,22 @@ impl error::Error for Error {
} }
} }
/// Marker trait for indicating that an instance of `Secp256k1` can be used for signing.
pub trait Signing {} pub trait Signing {}
/// Marker trait for indicating that an instance of `Secp256k1` can be used for verification.
pub trait Verification {} pub trait Verification {}
/// Represents the empty set of capabilities.
pub struct None {} pub struct None {}
/// Represents the set of capabilities needed for signing.
pub struct SignOnly {} pub struct SignOnly {}
/// Represents the set of capabilities needed for verification.
pub struct VerifyOnly {} pub struct VerifyOnly {}
/// Represents the set of all capabilities.
pub struct All {} pub struct All {}
impl Signing for SignOnly {} impl Signing for SignOnly {}
@ -406,7 +416,7 @@ impl<C> Clone for Secp256k1<C> {
} }
impl<C> PartialEq for Secp256k1<C> { impl<C> PartialEq for Secp256k1<C> {
fn eq(&self, other: &Secp256k1<C>) -> bool { true } fn eq(&self, _other: &Secp256k1<C>) -> bool { true }
} }
impl<C> Eq for Secp256k1<C> { } impl<C> Eq for Secp256k1<C> { }
@ -425,21 +435,21 @@ impl Secp256k1<None> {
} }
impl Secp256k1<All> { impl Secp256k1<All> {
/// Creates a new Secp256k1 context /// Creates a new Secp256k1 context with all capabilities
pub fn new() -> Secp256k1<All> { pub fn new() -> Secp256k1<All> {
Secp256k1 { ctx: unsafe { ffi::secp256k1_context_create(ffi::SECP256K1_START_SIGN | ffi::SECP256K1_START_VERIFY) }, phantom: PhantomData } Secp256k1 { ctx: unsafe { ffi::secp256k1_context_create(ffi::SECP256K1_START_SIGN | ffi::SECP256K1_START_VERIFY) }, phantom: PhantomData }
} }
} }
impl Secp256k1<SignOnly> { impl Secp256k1<SignOnly> {
/// Creates a new Secp256k1 context that can only be used for signing
pub fn signing_only() -> Secp256k1<SignOnly> { pub fn signing_only() -> Secp256k1<SignOnly> {
Secp256k1 { ctx: unsafe { ffi::secp256k1_context_create(ffi::SECP256K1_START_SIGN) }, phantom: PhantomData } Secp256k1 { ctx: unsafe { ffi::secp256k1_context_create(ffi::SECP256K1_START_SIGN) }, phantom: PhantomData }
} }
} }
impl Secp256k1<VerifyOnly> { impl Secp256k1<VerifyOnly> {
/// Creates a new Secp256k1 context that can only be used for verification
pub fn verification_only() -> Secp256k1<VerifyOnly> { pub fn verification_only() -> Secp256k1<VerifyOnly> {
Secp256k1 { ctx: unsafe { ffi::secp256k1_context_create(ffi::SECP256K1_START_VERIFY) }, phantom: PhantomData } Secp256k1 { ctx: unsafe { ffi::secp256k1_context_create(ffi::SECP256K1_START_VERIFY) }, phantom: PhantomData }
} }