[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-scheme] 02/02: data-string: Add cross-reference to C equivalents
From: |
gnunet |
Subject: |
[gnunet-scheme] 02/02: data-string: Add cross-reference to C equivalents. |
Date: |
Thu, 28 Jul 2022 18:08:56 +0200 |
This is an automated email from the git hooks/post-receive script.
maxime-devos pushed a commit to branch master
in repository gnunet-scheme.
commit 71910f53947ad64cfccc83ca45c1cc62189018c4
Author: Maxime Devos <maximedevos@telenet.be>
AuthorDate: Thu Jul 28 17:32:53 2022 +0200
data-string: Add cross-reference to C equivalents.
Helps with searching.
* gnu/gnunet/data-string.scm (data->string, string->data): Add
cross-reference for GNUNET_STRINGS_data_to_string and
GNUNET_STRINGS_string_to_data.
---
gnu/gnunet/data-string.scm | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/gnu/gnunet/data-string.scm b/gnu/gnunet/data-string.scm
index 30b9ece..8464d3d 100644
--- a/gnu/gnunet/data-string.scm
+++ b/gnu/gnunet/data-string.scm
@@ -1,5 +1,5 @@
;; This file is part of scheme-GNUnet, a partial Scheme port of GNUnet.
-;; Copyright (C) 2005--2007, 2020 GNUnet e.V.
+;; Copyright (C) 2005--2007, 2020, 2022 GNUnet e.V.
;;
;; GNUnet is free software: you can redistribute it and/or modify it
;; under the terms of the GNU Affero General Public License as published
@@ -37,6 +37,9 @@
(case-lambda
"Convert binary data to ASCII encoding using Crockford Base32 encoding.
+This corresponds with the @code{GNUNET_STRINGS_data_to_string} function
+of the C implementation.
+
@var{bv}: data to encode
@var{offset}: start position of data to encode
@var{size}: length of data to encode, in octets"
@@ -84,6 +87,9 @@ Base32 encoding."
(lambda (enc out-size)
"Convert Crockford Base32hex encoding back to data
+This corresponds with the @code{GNUNET_STRINGS_string_to_data} function
+of the C implementation.
+
Return the data as a bytevector on success, or return #f
if result has the wrong encoding.
@var{out-size} must exactly match the size of the data before it was encoded.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.