Pudu programming language
Menu

Std.Bytes.Cursor.peek

1 declaration

fn

peek: &Std.Bytes.Cursor.Cursor -> Result[Option[UInt8], Std.Bytes.Cursor.CursorError]

This is a callable function.

What it does

Observe the next byte without consuming it; EOF is `None`.

Read the signature

  • The text after the name is the type checked by Pudu.
  • Read arrows from left to right: inputs come first, and the final type is returned.
  • & borrows a value for this call instead of moving or copying it.
  • Names inside [ ] are type arguments, such as the item type held by a collection.
  • Option holds Some(value) or None when no value is available.
  • Result makes success and recoverable failure part of the function's type.

Back to Std.Bytes.CursorSearch related declarations