zecfoundation
/
redjubjub
mirror of https://github.com/ZcashFoundation/redjubjub.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Make Binding, SpendAuth enums so they show in a different Rustdoc section.

This commit is contained in:
Henry de Valence 2019-12-04 16:41:16 -08:00
parent 2c3b411362
commit a3f0830bc1
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib.rs
View File

@ -25,7 +25,8 @@ pub use public_key::{PublicKey, PublicKeyBytes};
pub use secret_key::SecretKey; pub use secret_key::SecretKey;
pub use signature::Signature; pub use signature::Signature;
/// Abstracts over different RedJubJub parameter choices. /// Abstracts over different RedJubJub parameter choices, [`Binding`]
/// and [`SpendAuth`].
/// ///
/// As described [at the end of §5.4.6][concretereddsa] of the Zcash /// As described [at the end of §5.4.6][concretereddsa] of the Zcash
/// protocol specification, the generator used in RedJubjub is left as /// protocol specification, the generator used in RedJubjub is left as
@ -40,12 +41,12 @@ pub trait SigType: private::Sealed {}
/// A type variable corresponding to Zcash's `BindingSig`. /// A type variable corresponding to Zcash's `BindingSig`.
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub struct Binding {} pub enum Binding {}
impl SigType for Binding {} impl SigType for Binding {}
/// A type variable corresponding to Zcash's `SpendAuthSig`. /// A type variable corresponding to Zcash's `SpendAuthSig`.
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub struct SpendAuth {} pub enum SpendAuth {}
impl SigType for SpendAuth {} impl SigType for SpendAuth {}
pub(crate) mod private { pub(crate) mod private {