Home / Docs / Standard library / Built-in methods

peek

Release v0.4.0Edition 0.5 preview

A built-in method, resolved by the type of its receiver (spec/14 §2). Edition 0.5 preview.

una
s.peek() -> Option[T]
  where s: Stack[T]
q.peek() -> Option[T]
  where q: Queue[T]
q.peek() -> Option[T]
  where q: PriorityQueue[T, P]

The top of a Stack or the front of a Queue, the item pop would remove, as Some, and None exactly when it is empty, in O(1) time (spec/28 §5). On a PriorityQueue, the item pop would give, in O(1) time (spec/28 §8).

Specification

Generated from una v0.4.0 (docs/std/builtins.json, which is not part of the specification): built-in methods have no declaration, so una writes these signature lines and tests each against its checker. The specification governs: spec/14 §2.