gossamer - v6.3.0

gossamer/iterator

Types

Iterator

</> 
pub type Iterator(a, return, next)

Values

for

</> 
pub fn for(
  in iterator: Iterator(a, return, next),
  run fun: fn(a) -> any,
) -> Nil

from_list

</> 
pub fn from_list(list: List(a)) -> Iterator(a, Nil, Nil)

Creates an iterator from a Gleam list.

new

</> 
pub fn new(
  next: fn(option.Option(next)) -> iterator_result.IteratorResult(
    a,
    return,
  ),
) -> Iterator(a, return, next)

next

</> 
pub fn next(
  iterator: Iterator(a, return, next),
) -> iterator_result.IteratorResult(a, return)

next_with

</> 
pub fn next_with(
  iterator: Iterator(a, return, next),
  value: next,
) -> iterator_result.IteratorResult(a, return)

return

</> 
pub fn return(
  iterator: Iterator(a, return, next),
) -> Result(iterator_result.IteratorResult(a, return), Nil)

return_with

</> 
pub fn return_with(
  iterator: Iterator(a, return, next),
  value: return,
) -> Result(iterator_result.IteratorResult(a, return), Nil)

throw

</> 
pub fn throw(
  iterator: Iterator(a, return, next),
  reason reason: e,
) -> Result(iterator_result.IteratorResult(a, return), Nil)

to_list

</> 
pub fn to_list(iterator: Iterator(a, return, next)) -> List(a)

Collects all values from an iterator into a list. Consumes the iterator.

with_return

</> 
pub fn with_return(
  iterator: Iterator(a, return, next),
  return: fn(option.Option(return)) -> iterator_result.IteratorResult(
    a,
    return,
  ),
) -> Iterator(a, return, next)

with_throw

</> 
pub fn with_throw(
  iterator: Iterator(a, return, next),
  throw: fn(e) -> iterator_result.IteratorResult(a, return),
) -> Iterator(a, return, next)
✨ Search Document