trieIterator.h File Reference

A trie iterator. More...

#include <stdbool.h>

Include dependency graph for trieIterator.h:

Go to the source code of this file.

Functions
tetengo_trie_trieIterator_t *	tetengo_trie_trieIterator_create (const tetengo_trie_trie_t *p_trie)
	Creates an iterator.
void	tetengo_trie_trieIterator_destroy (const tetengo_trie_trieIterator_t *p_iterator)
	Destroys an iterator.
const void *	tetengo_trie_trieIterator_get (const tetengo_trie_trieIterator_t *p_iterator)
	Dereferences the iterator.
bool	tetengo_trie_trieIterator_hasNext (const tetengo_trie_trieIterator_t *p_iterator)
	Returns true when the iterator will return more elements.
void	tetengo_trie_trieIterator_next (tetengo_trie_trieIterator_t *p_iterator)
	Increments the iterator.

Detailed Description

A trie iterator.

Copyright (C) 2019-2023 kaoru https://www.tetengo.org/

Function Documentation

tetengo_trie_trieIterator_create()

tetengo_trie_trieIterator_t * tetengo_trie_trieIterator_create

(

const tetengo_trie_trie_t *

p_trie

)

Creates an iterator.

Parameters

p_trie

A pointer to a trie.

Returns

A pointer to an iterator. Or NULL on error.

tetengo_trie_trieIterator_destroy()

void tetengo_trie_trieIterator_destroy

(

const tetengo_trie_trieIterator_t *

p_iterator

)

Destroys an iterator.

Parameters

p_iterator

A pointer to an iterator.

tetengo_trie_trieIterator_get()

const void * tetengo_trie_trieIterator_get

(

const tetengo_trie_trieIterator_t *

p_iterator

)

Dereferences the iterator.

Parameters

p_iterator

A pointer to an iterator.

Returns

The dereferenced value. Or NULL on error.

tetengo_trie_trieIterator_hasNext()

bool tetengo_trie_trieIterator_hasNext

(

const tetengo_trie_trieIterator_t *

p_iterator

)

Returns true when the iterator will return more elements.

Parameters

p_iterator

A pointer to an iterator.

Return values

true	When the iterator will return more elements.
false	Otherwise.

tetengo_trie_trieIterator_next()

void tetengo_trie_trieIterator_next

(

tetengo_trie_trieIterator_t *

p_iterator

)

Increments the iterator.

Parameters

p_iterator

A pointer to an iterator.