logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Digest.S - The signature for a hash function that produces digests of length hash_length from character

Documentation

       Module type S
        = sigend

       The signature for a hash function that produces digests of length  hash_length  from  character  strings,
       byte arrays, and files.

       Since 5.2

       typet = string

       The type of digests.

       valhash_length : int

       The length of digests, in bytes.

       valcompare : t->t->int

       Compare two digests, with the same specification as compare .

       valequal : t->t->bool

       Test two digests for equality.

       valstring : string->t

       Return the digest of the given string.

       valbytes : bytes->t

       Return the digest of the given byte sequence.

       valsubstring : string->int->int->tsubstringsofslen  returns the digest of the substring of s starting at index ofs and containing len
       characters.

       valsubbytes : bytes->int->int->tsubbytessofslen returns the digest of the subsequence of s starting at index ofs  and  containing  len
       bytes.

       valchannel : in_channel->int->t

       Read characters from the channel and return their digest.  See Digest.channel for the full specification.

       valfile : string->t

       Return the digest of the file whose name is given.

       valoutput : out_channel->t->unit

       Write a digest on the given output channel.

       valinput : in_channel->t

       Read a digest from the given input channel.

       valto_hex : t->string

       Return the printable hexadecimal representation of the given digest.

       RaisesInvalid_argument if the length of the argument is not hash_length ,

       valof_hex : string->t

       Convert a hexadecimal representation back into the corresponding digest.

       RaisesInvalid_argument  if  the  length  of  the  argument is not 2*hash_length , or if the arguments
       contains non-hexadecimal characters.

OCamldoc                                           2025-06-12                                       Digest.S(3o)

Module Type

       Module type   Digest.S

Name

       Digest.S  -  The signature for a hash function that produces digests of length hash_length from character
       strings, byte arrays, and files.

See Also