Module description

hci -- Hash Cell Table Iterator

The hci module implements an iterator on the hash cell table hct.

Iterator structure

hci% ( -- n )

Get the required space for a hash cell table iterator

Iterator creation, initialisation and destruction words

hci-init ( hct hci -- )

Initialise the iterator with a hash table

hci-create ( hct "<spaces>name" -- ; -- hci )

Create a named iterator in the dictionary on the hash table hct

hci-new ( hct -- hci )

Create an iterator on the heap on the hash table hct

hci-free ( hci -- )

Free the iterator from heap

Member words

hci-get ( hci -- false | x true )

Get the cell data x from the current record

hci-key ( hci -- c-addr u )

Get the key from the current record

hci-set ( x hci -- )

Set the cell data x in the current record

Iterator words

hci-first ( hci -- x true | false )

Move the iterator to the first record, return the cell data of this record

hci-next ( hci -- x true | false )

Move the iterator to the next record, return the cell data from this record

hci-move ( x hci -- flag )

Move the iterator to the next record with the cell data x, return success

hci-first? ( hci -- flag )

Check if the iterator is on the first record

hci-last? ( hci -- flag )

Check if the iterator is on the last record

Inspection

hci-dump ( hci -- )

Dump the iterator

Generated by fsdocgen 0.1.0