aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/interfaces.rst
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2014-04-15 13:57:10 +0100
committerAlex Stapleton <alexs@prol.etari.at>2014-04-15 13:57:10 +0100
commitb30ecd747e5834614794243e83e62cac65bfe549 (patch)
treeea5eb0cfa12d0738724935013205c3292054b52a /docs/hazmat/primitives/interfaces.rst
parent3c75966ac5c9308eb5868a2487d94f754e17ade2 (diff)
parenta0f9850e6d45a60715685a5d07d395db9f317ad4 (diff)
downloadcryptography-b30ecd747e5834614794243e83e62cac65bfe549.tar.gz
cryptography-b30ecd747e5834614794243e83e62cac65bfe549.tar.bz2
cryptography-b30ecd747e5834614794243e83e62cac65bfe549.zip
Merge pull request #920 from Ayrx/missing-docs
Added missing HashContext documentation
Diffstat (limited to 'docs/hazmat/primitives/interfaces.rst')
-rw-r--r--docs/hazmat/primitives/interfaces.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index 9a1f3307..cdb925ee 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -402,6 +402,27 @@ Hash algorithms
The internal block size of the hash algorithm in bytes.
+.. class:: HashContext
+
+ .. attribute:: algorithm
+
+ A :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` that
+ will be used by this context.
+
+ .. method:: update(data)
+
+ :param data bytes: The data you want to hash.
+
+ .. method:: finalize()
+
+ :return: The final digest as bytes.
+
+ .. method:: copy()
+
+ :return: A :class:`~cryptography.hazmat.primitives.interfaces.HashContext`
+ that is a copy of the current context.
+
+
Key derivation functions
~~~~~~~~~~~~~~~~~~~~~~~~