From 61daa9dce6c2c5011b63db3e6849d5ad73b2e6d5 Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 6 Jul 2018 00:12:35 +0000 Subject: [PATCH] Add a doctest for Scalar::from_u64(). --- src/scalar.rs | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/scalar.rs b/src/scalar.rs index f490948..328af05 100644 --- a/src/scalar.rs +++ b/src/scalar.rs @@ -527,6 +527,26 @@ impl Scalar { } /// Construct a scalar from the given `u64`. + /// + /// # Inputs + /// + /// An `u64` to convert to a `Scalar`. + /// + /// # Returns + /// + /// A `Scalar` corresponding to the input `u64`. + /// + /// # Example + /// + /// ``` + /// use curve25519_dalek::scalar::Scalar; + /// + /// let fourtytwo = Scalar::from_u64(42); + /// let six = Scalar::from_u64(6); + /// let seven = Scalar::from_u64(7); + /// + /// assert!(fourtytwo == six * seven); + /// ``` pub fn from_u64(x: u64) -> Scalar { let mut s_bytes = [0u8; 32]; for i in 0..8 {