Changeset 36737 in project


Ignore:
Timestamp:
10/28/18 19:59:19 (2 weeks ago)
Author:
kon
Message:

rel 4.1.2

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/message-digest-utils

    r36712 r36737  
    1313
    1414For best results the source object(s) to be accumulated into the digest should be
    15 something easily treated as a {}{bytevector}}.
     15something easily treated as a {{bytevector}}.
    1616
    1717
     
    412412==== message-digest-chunk-port-read-maker
    413413
    414 <parameter>(message-digest-chunk-port-read-maker [CONSTRUCTOR]) -> procedure</parameter>
     414<parameter>(message-digest-chunk-port-read-maker [CTOR]) -> procedure</parameter>
    415415
    416416Supplies the procedure used to create an input procedure.
    417417
    418 {{CONSTRUCTOR}} is a {{(INPUT-PORT #!optional SIZE) -> (-> byte-source)}}. The
    419 first argument is the chunk source port and the second argument is the size of
    420 chunks.
    421 
    422 The default {{CONSTRUCTOR}} will return a procedure that reads from
    423 {{INPUT-PORT}} in {{(message-digest-chunk-size)}} bytes.
     418; {{CTOR}} : {{(PORT #!optional SIZE) -> (-> byte-source)}}
     419; {{PORT}} : source open input port
     420; {{SIZE}} : chunk size, default {{(message-digest-chunk-size)}}
     421
     422The default {{CTOR}} returns a reader from {{PORT}} in {{SIZE}} bytes.
    424423
    425424==== message-digest-chunk-fileno-read-maker
    426425
    427 <parameter>(message-digest-chunk-fileno-read-maker [CONSTRUCTOR]) -> procedure</parameter>
     426<parameter>(message-digest-chunk-fileno-read-maker [CTOR]) -> procedure</parameter>
    428427
    429428Supplies the procedure used to create an input procedure.
    430429
    431 {{CONSTRUCTOR}} is a {{FD #!optional SIZE) -> (-> byte-source))}}. The first
    432 argument is the chunk source open fileno and the second argument is the size
    433 of chunks.
    434 
    435 The default {{CONSTRUCTOR}} will return a procedure that reads from {{FD}} in
    436 {{(file-size FD)}} bytes.
     430; {{CTOR}} : {{(FD #!optional TOTAL SIZE) -> (-> byte-source)}}
     431; {{FD}} : source open fileno
     432; {{TOTAL}} : total size, default {{(file-size FD))}}
     433; {{SIZE}} : chunk size, default {{(message-digest-chunk-size)}}
     434
     435The default {{CTOR}} returns a reader conditioned on memory-mapped-file
     436support.
    437437
    438438==== message-digest-chunk-size
     
    443443update phase. Used by the default {{message-digest-chunk-read-maker}}.
    444444
    445 {{SIZE}} is a {{positive-integer}}, with default {{1024}}.
     445; {{SIZE}} : {{positive-integer}}, default {{1024}}
    446446
    447447==== message-digest-chunk-converter
    448448
    449 <parameter>(message-digest-chunk-converter [CONVERTER]) -> (or #f procedure)</parameter>
     449<parameter>(message-digest-chunk-converter [CONV]) -> (or #f procedure)</parameter>
    450450
    451451The procedure used to translate an arbitrary object into something
    452452suitable for an {{UPDATE}} procedure. See {{make-message-digest-primitive}}.
    453453
    454 {{CONVERTER}} is a {{(* -> byte-source)}} or {{#f}}.
    455 
    456 The default {{CONVERTER}} is {{#f}}.
    457 
    458 Should the {{CONVERTER}} be {{#f}} or return {{#f}} then no translation is attempted.
    459 
    460 ==== message-digest-chunk-read-maker (DEPRECATED)
    461 
    462 <parameter>(message-digest-chunk-read-maker [CONSTRUCTOR]) -> procedure</parameter>
    463 
    464 Synonym for {{message-digest-chunk-port-read-maker}}.
     454; {{CONV}} : {{(* -> byte-source)}} or {{#f}}, default {{#f}}
     455
     456Should the {{CONV}} be {{#f}} or return {{#f}} then no translation is
     457attempted.
    465458
    466459
     
    518511== Version history
    519512
     513; 4.1.2 : .
    520514; 4.0.0 : CHICKEN 5 release.
    521 ; 3.9.0 : Add types.
    522 ; 3.8.0 : Fix {{message-digest-primitive?}}; accept {{*}}.
    523 ; 3.7.1 :
    524 ; 3.7.0 : Add {{message-digest-object!}}, {{message-digest-file!}}, and {{message-digest-port!}}.
    525 ; 3.6.0 : Add {{START}} and/or {{END}} optional arguments.
    526 ; 3.5.0 : Add {{finalize-message-digest!}}.
    527 ; 3.4.0 : Deprecate {{message-digest-chunk-read-maker}}. Add {{message-digest-chunk-port-read-maker}}, {{message-digest-chunk-fileno-read-maker}}. Add {{message-digest-primitive-raw-update}}.
    528 ; 3.3.0 : Deprecate {{message-digest-default-result-type}}. Add {{message-digest-result-form}}.
    529 ; 3.2.0 : Add {{message-digest-default-result-type}}. {{message-digest-chunk-*}} are parameters.
    530 ; 3.1.1 : Fix {{check-u8vector}} import.
    531 ; 3.1.0 : Added optional {{message-digest-primitive-block-length}}.
    532 ; 3.0.5 : Reverted 64 bit support.
    533 ; 3.0.4 : Removed 64 bit support.
    534 ; 3.0.3 :
    535 ; 3.0.2 : Use of compiled setup-helper.
    536 ; 3.0.1 :
    537 ; 3.0.0 : Removed deprecated procedures to own module. Removed integer packing procedures. Split into many modules. Deprecated some procedures.
    538 ; 2.3.8 : Treat integers as unsigned. (Ticket #534) Uses blob for finalization result buffer.
    539 ; 2.3.7 : Remove no checks optimization compier options.
    540 ; 2.3.6 : Deprecated close-output-digest. Restricted no checks optimization compier option.
    541 ; 2.3.5 : The {{'u8vector}} {{RESULT-FORM}} is slightly faster. Revert to allocated context memory.
    542 ; 2.3.4 : Try w/o C-level memory allocation so no finalizer needed.
    543 ; 2.3.3 : The {{'blob}} {{RESULT-FORM}} is slightly faster.
    544 ; 2.3.2 : Deprecated {{byte-string->hexadecimal}}. Deprecated {{string->hex}}, use [[string-utils]] {{string-hexadecimal#string->hex}}. Fix for the default {{message-digest-chunk-read-maker}}, blob was always chunk-size.
    545 ; 2.3.1 : Moved some utility routines into own egg(s).
    546 ; 2.3.0 : Added {{message-digest-update-char-u8}}, {{message-digest-update-char-be}}, and {{message-digest-update-char-le}}. {{message-digest-update-char}} now treats the actual bit-width of char correctly.
    547 ; 2.2.0 : Added [[Byte Packing]] API. Downgraded {{message-digest-chunk-read-maker}}, {{message-digest-chunk-size}} & {{message-digest-chunk-converter}} from {{parameter}}.
    548 ; 2.1.1 : Bug fix for hexstring: must use lowercase.
    549 ; 2.1.0 : Added message digest "phase" and port APIs. Deprecated old API.
    550 ; 2.0.1 : Bug fix for {{(message-digest-chunk-converter)}} use by {{make-binary-message-digest}}.
    551 ; 2.0.0 : Release for Chicken 4 [From a diff provided by Christian Kellermann]
    552515
    553516
    554517== License
    555518
    556   Copyright (C) 2006-2018 Kon Lovett.  All rights reserved.
     519  Copyright (C) 2018 Kon Lovett.  All rights reserved.
    557520
    558521  Permission is hereby granted, free of charge, to any person obtaining a
Note: See TracChangeset for help on using the changeset viewer.