View Source Orb.Iterator behaviour (Orb v0.1.1)

Summary

Types

var_ref()

Callbacks

next(var_ref)

Mutates the iterator advancing it to the next element.

valid?(var_ref)

Calculates whether the iterator is done or not.

value(var_ref)

Extracts or calculates the current element value.

value_type()

The type for iterated elements.

Types

Link to this type

var_ref()

View Source 
@type var_ref() :: %Orb.VariableReference{
  entries: term(),
  pop_type: term(),
  push_type: term()
}

Callbacks

Link to this callback

next(var_ref)

View Source 
@callback next(var_ref()) ::
  %Orb.Instruction{
    operands: term(),
    operation: term(),
    pop_type: term(),
    push_type: term()
  }
  | integer()
  | float()

Mutates the iterator advancing it to the next element.

Link to this callback

valid?(var_ref)

View Source 
@callback valid?(var_ref()) ::
  %Orb.Instruction{
    operands: term(),
    operation: term(),
    pop_type: term(),
    push_type: term()
  }
  | integer()

Calculates whether the iterator is done or not.

Link to this callback

value(var_ref)

View Source 
@callback value(var_ref()) ::
  %Orb.Instruction{
    operands: term(),
    operation: term(),
    pop_type: term(),
    push_type: term()
  }
  | integer()
  | float()

Extracts or calculates the current element value.

Link to this callback

value_type()

View Source 
@callback value_type() :: atom() | tuple()

The type for iterated elements.