Module description

hni -- Generic Hash Table Iterator

The hni module implements an iterator on the generic hash table hnt.

Iterator structure

hni% ( -- n )

Get the required space for a hash table base iterator variable

Iterator creation, initialisation and destruction words

hni-init ( hnt hni -- )

Initialise the iterator with the hash table hnt

hni-create ( hnt "<spaces>name" -- ; -- hni )

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

hni-new ( hnt -- hni )

Create an iterator on the heap on the hash table hnt

hni-free ( hni -- )

Free iterator from heap

Member words

hni-get ( hni -- hnn | nil )

Get the node from the current record

hni-key ( hni -- c-addr u )

Get the key from the current record

Iterator words

hni-first ( hni -- hnn | nil )

Move the iterator to the first record, return the node in this record

hni-next ( hni -- hnn | nil )

Move the iterator to the next record, return the node in this record

hni-first? ( hni -- flag )

Check if the iterator is on the first record

hni-last? ( hni -- flag )

Check if the iterator is on the last record

Inspection

hni-dump ( hni -- )

Dump the iterator

Generated by fsdocgen 0.1.0