Skip to content

iter.h#

Nst_IterObj interface.

Authors#

TheSilvered

Functions#

Nst_iter_new#

Synopsis:

Nst_ObjRef *Nst_iter_new(Nst_ObjRef *start, Nst_ObjRef *next,
                         Nst_ObjRef *value)

Description:

Create a new Nest iterator object.

Note

This function takes one reference of start, next and value both on success and on failure.

Parameters:

  • start: the start function for the new iterator
  • next: the next function for the new iterator
  • value: the value for the new iterator

Returns:

The new object or NULL on failure. The error is set.

_Nst_iter_traverse#

Synopsis:

void _Nst_iter_traverse(Nst_Obj *iter)

Description:

Nst_ObjTrav function for Iter objects.

Nst_iter_start_func#

Synopsis:

Nst_Obj *Nst_iter_start_func(Nst_Obj *iter)

Returns:

The start function of an iterator. No reference is added.

Nst_iter_next_func#

Synopsis:

Nst_Obj *Nst_iter_next_func(Nst_Obj *iter)

Returns:

The next function of an iterator. No reference is added.

Nst_iter_value#

Synopsis:

Nst_Obj *Nst_iter_value(Nst_Obj *iter)

Returns:

The value passed to start and next of an iterator. No reference is added.

Nst_iter_start#

Synopsis:

bool Nst_iter_start(Nst_Obj *iter)

Description:

Call the start function of an Iter object.

Parameters:

  • iter: the iterator to start

Returns:

true on success and false on success. The error is set.

Nst_iter_next#

Synopsis:

Nst_ObjRef *Nst_iter_next(Nst_Obj *iter)

Description:

Call the next function of an Iter object.

Parameters:

  • iter: the iterator to get the value from

Returns:

The resulting object on success and NULL on failure. The error is set.

Nst_iter_range_new#

Synopsis:

Nst_ObjRef *Nst_iter_range_new(i64 start, i64 stop, i64 step)

Description:

Create a new range object.

Nst_iter_seq_new#

Synopsis:

Nst_ObjRef *Nst_iter_seq_new(Nst_Obj *seq)

Description:

Create a new sequence iterator.

Nst_iter_str_new#

Synopsis:

Nst_ObjRef *Nst_iter_str_new(Nst_Obj *seq)

Description:

Create a new string iterator.

Nst_iter_map_new#

Synopsis:

Nst_ObjRef *Nst_iter_map_new(Nst_Obj *seq)

Description:

Create a new map iterator.

Nst_iter_range_start#

Synopsis:

Nst_ObjRef *Nst_iter_range_start(usize arg_num, Nst_Obj **args)

Description:

The start function of the range iterator.

Nst_iter_range_next#

Synopsis:

Nst_ObjRef *Nst_iter_range_next(usize arg_num, Nst_Obj **args)

Description:

The next function of the range iterator.

Nst_iter_seq_start#

Synopsis:

Nst_ObjRef *Nst_iter_seq_start(usize arg_num, Nst_Obj **args)

Description:

The start function of the sequence iterator.

Nst_iter_seq_next#

Synopsis:

Nst_ObjRef *Nst_iter_seq_next(usize arg_num, Nst_Obj **args)

Description:

The next function of the sequence iterator.

Nst_iter_str_start#

Synopsis:

Nst_ObjRef *Nst_iter_str_start(usize arg_num, Nst_Obj **args)

Description:

The start function of the string iterator.

Nst_iter_str_next#

Synopsis:

Nst_ObjRef *Nst_iter_str_next(usize arg_num, Nst_Obj **args)

Description:

The next function of the string iterator.

Nst_iter_map_start#

Synopsis:

Nst_ObjRef *Nst_iter_map_start(usize arg_num, Nst_Obj **args)

Description:

The start function of the map iterator.

Nst_iter_map_next#

Synopsis:

Nst_ObjRef *Nst_iter_map_next(usize arg_num, Nst_Obj **args)

Description:

The next function of the map iterator.