Pudu programming language
Menu
API reference

Std.RingBuffer.pop

1 declaration

fn

pop: &Std.RingBuffer.RingBuffer -> Option[Std.RingBuffer.PopResult]

This is a callable function.

What it does

Dequeues an item from the head of the buffer. Returns None if the buffer is empty.

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.

Back to Std.RingBufferSearch related declarations