hashset_itr.h File Reference

A C hashset iterator implemenation. More...

#include "hashset.h"

Go to the source code of this file.

Data Structures
struct	hashset_itr_st
	A hashset iterator. More...

Typedefs
typedef struct hashset_itr_st *	hashset_itr_t

Functions
hashset_itr_t	hashset_iterator (hashset_t set)
	Create a hashset iterator.
int	hashset_iterator_has_next (hashset_itr_t itr)
	Return 1 if there is a next value in the hashset and 0 otherwise.
int	hashset_iterator_next (hashset_itr_t itr)
	Advance to the next value in the hashset.
void *	hashset_iterator_value (hashset_itr_t itr)
	Return the value at the current index.

Detailed Description

A C hashset iterator implemenation.

This is a simple iterator for a hashset. It is not thread-safe.

License

Copyright 2012 Couchbase, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Modified in 2022 by Edward A. Lee to conform to documentation standards. Also, changed the logic to iterate using just hashset_iterator_next().

Typedef Documentation

hashset_itr_t

typedef struct hashset_itr_st* hashset_itr_t