wanderer/ BLAKE3
1
0
Fork 0
mirror of https://github.com/BLAKE3-team/BLAKE3 synced 2024-05-10 12:46:04 +02:00
Code Issues Releases Activity

add some horizontal rules to the C readme

This commit is contained in:
Jack O'Connor 2020-09-10 17:38:35 -04:00
parent ac1da75bb9
commit a01fd16011
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
c/README.md
View File

@ -71,6 +71,8 @@ void blake3_hasher_init(
Initialize a `blake3_hasher` in the default hashing mode. Initialize a `blake3_hasher` in the default hashing mode.
---
```c ```c
void blake3_hasher_update( void blake3_hasher_update(
blake3_hasher *self, blake3_hasher *self,
@ -80,6 +82,8 @@ void blake3_hasher_update(
Add input to the hasher. This can be called any number of times. Add input to the hasher. This can be called any number of times.
---
```c ```c
void blake3_hasher_finalize( void blake3_hasher_finalize(
const blake3_hasher *self, const blake3_hasher *self,
@ -103,6 +107,8 @@ void blake3_hasher_init_keyed(
Initialize a `blake3_hasher` in the keyed hashing mode. The key must be Initialize a `blake3_hasher` in the keyed hashing mode. The key must be
exactly 32 bytes. exactly 32 bytes.
---
```c ```c
void blake3_hasher_init_derive_key( void blake3_hasher_init_derive_key(
blake3_hasher *self, blake3_hasher *self,
@ -122,6 +128,8 @@ database at runtime. A good default format for the context string is
This function is intended for application code written in C. For This function is intended for application code written in C. For
language bindings, see `blake3_hasher_init_derive_key_raw` below. language bindings, see `blake3_hasher_init_derive_key_raw` below.
---
```c ```c
void blake3_hasher_init_derive_key_raw( void blake3_hasher_init_derive_key_raw(
blake3_hasher *self, blake3_hasher *self,
@ -140,6 +148,8 @@ which takes the context as a C string. If you need to use arbitrary
bytes as a context string in application code, consider whether you're bytes as a context string in application code, consider whether you're
violating the requirement that context strings should be hardcoded. violating the requirement that context strings should be hardcoded.
---
```c ```c
void blake3_hasher_finalize_seek( void blake3_hasher_finalize_seek(
const blake3_hasher *self, const blake3_hasher *self,