From 74a28559c4acb6fc6bf8d0089d3d628377c42a1c Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Tue, 17 Jul 2018 00:22:34 +0000 Subject: [PATCH] Add example code for Scalar.to_bytes() and Scalar.as_bytes(). --- src/scalar.rs | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/scalar.rs b/src/scalar.rs index 3219bfc..4e9286d 100644 --- a/src/scalar.rs +++ b/src/scalar.rs @@ -533,11 +533,31 @@ impl Scalar { } /// Convert this `Scalar` to its underlying sequence of bytes. + /// + /// # Example + /// + /// ``` + /// use curve25519_dalek::scalar::Scalar; + /// + /// let s: Scalar = Scalar::zero(); + /// + /// assert!(s.to_bytes() == [0u8; 32]); + /// ``` pub fn to_bytes(&self) -> [u8; 32] { self.bytes } - /// View this `Scalar` as a sequence of bytes. + /// View this `Scalar` as its underlying sequence of bytes. + /// + /// # Example + /// + /// ``` + /// use curve25519_dalek::scalar::Scalar; + /// + /// let s: Scalar = Scalar::zero(); + /// + /// assert!(s.as_bytes() == &[0u8; 32]); + /// ``` pub fn as_bytes(&self) -> &[u8; 32] { &self.bytes }