Loyc.Collections.Impl.IEnumeratorFrame< Frame, T > Interface Template Reference

Helper interface for NestedEnumerator{Frame, T}. More...

---

Source file:

• /Core/Loyc.Collections/Other/NestedEnumerator.cs

Inheritance diagram for Loyc.Collections.Impl.IEnumeratorFrame< Frame, T >:

Remarks

Helper interface for NestedEnumerator{Frame, T}.

Template Parameters

Frame	A data type that implements this interface.
T	Type of items enumerated by this interface.

Type Constraints

Frame	:	IEnumeratorFrame
Frame	:	Frame
Frame	:	T

Public Member Functions
int	MoveNext (ref Frame frame, ref T current)
	Enumerates the next item, or the next child collection. More...

Member Function Documentation

int Loyc.Collections.Impl.IEnumeratorFrame< Frame, T >.MoveNext	(	ref Frame	frame,
		ref T	current
	)

Enumerates the next item, or the next child collection.

Parameters

frame	Current frame (on entry, 'frame' is the same as 'this'). To begin enumerating a child frame, this method must change 'frame' to the desired child frame and return -1.
current	Current item (on entry, 'current' is value most recently enumerated by NestedEnumerator{Frame,T}.) To enumerate an item, MoveNext must change the value of 'current' and return 1.

Returns

1 to enumerate 'current', 0 when there are no more items in this frame's sequence, and any other value to enumerate a child frame.