Module Stdlib.Digest
Contents
Instructions: Use this module in your project
In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:
Add the following to your project's
dependencies/CMakeLists.txt
:DkSDKProject_DeclareAvailable(ocaml CONSTRAINT "= 4.14.0" FINDLIBS str unix runtime_events threads dynlink) DkSDKProject_MakeAvailable(ocaml)
Add the
Findlib::ocaml
library to any desired targets insrc/*/CMakeLists.txt
:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::ocaml)
Click your IDE's
Build
button
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install ocaml.4.14.0
Edit your
dune-project
and add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (ocaml (>= 4.14.0))))
Then run:
dune build *.opam # if this fails, run: dune build
Edit your
<package>.opam
file and add:depends: [ # ... existing dependencies ... "ocaml" {>= "4.14.0"} ]
Then run:
opam install . --deps-only
FINALLY, add the library to any desired
(library)
and/or (executable)
targets in your **/dune
files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
))
type
t`` = string
The type of digests: 16-character strings.
The comparison function for 16-character digest, with the same
specification as Stdlib.compare
and the
implementation shared with
String.compare
. Along with the type
t
, this function compare
allows the module Digest
to be passed as
argument to the functors Set.Make
and
Map.Make
.
- since 4.00.0
val
string : ``string
->
t
Return the digest of the given string.
val
bytes : ``bytes
->
t
Return the digest of the given byte sequence.
- since 4.02.0
val
substring : ``string
->
``int
->
``int
->
t
Digest.substring s ofs len
returns the digest of the substring of s
starting at index ofs
and containing len
characters.
val
subbytes : ``bytes
->
``int
->
``int
->
t
Digest.subbytes s ofs len
returns the digest of the subsequence of s
starting at index ofs
and containing len
bytes.
- since 4.02.0
val
channel :
in_channel
->
``int
->
t
If len
is nonnegative, Digest.channel ic len
reads len
characters
from channel ic
and returns their digest, or raises End_of_file
if
end-of-file is reached before len
characters are read. If len
is
negative, Digest.channel ic len
reads all characters from ic
until
end-of-file is reached and return their digest.
val
file : ``string
->
t
Return the digest of the file whose name is given.
val
output :
out_channel
->
t
->
unit
Write a digest on the given output channel.
val
input :
in_channel
->
t
Read a digest from the given input channel.
val
to_hex :
t
->
string
Return the printable hexadecimal representation of the given digest.
-
raises Invalid_argument
if the argument is not exactly 16 bytes.
val
from_hex : ``string
->
t
Convert a hexadecimal representation back into the corresponding digest.
-
raises Invalid_argument
if the argument is not exactly 32 hexadecimal characters.
-
since 4.00.0