The module type of Array for this ring buffer

Defines the bounded ring buffer type

Raised in querying functions when the buffer is empty

create size creates a new bounded buffer with given size. The underlying array is allocated immediately and no further (large) allocation will happen from now on.

• raises Invalid_argument

  if the argument is < 1.

Make a fresh copy of the buffer.

Length of the inner buffer.

Number of elements currently stored in the buffer.

true if pushing an element would erase another element.

• since 1.3

blit_from buf from_buf o len copies the slice o, ... o + len - 1 from an input buffer from_buf to the end of the buffer. If the slice is too large for the buffer, only the last part of the array will be copied.

• raises Invalid_argument

  if o,len is not a valid slice of s.

blit_into buf to_buf o len copies at most len elements from buf into to_buf starting at offset o in s.

• returns

  the number of elements actually copied (min len (length buf)).

• raises Invalid_argument

  if o,len is not a valid slice of s.

append b ~into copies all data from b and adds it at the end of into. Erases data of into if there is not enough room.

Extract the current content into a list.

Clear the content of the buffer

Is the buffer empty (i.e. contains no elements)?

Drop the front element from t.

• raises Empty

  if the buffer is already empty.

Drop the back element from t.

• raises Empty

  if the buffer is already empty.

skip b len removes len elements from the front of b.

• raises Invalid_argument

  if len > length b.

iter b ~f calls f i t for each element t in buf.

iteri b ~f calls f i t for each element t in buf, with i being its relative index within buf.

get_front buf i returns the i-th element of buf from the front, i.e. the one returned by take_front buf after i-1 calls to junk_front buf.

• raises Invalid_argument

  if the index is invalid (> length buf).

get_back buf i returns the i-th element of buf from the back, i.e. the one returned by take_back buf after i-1 calls to junk_back buf.

• raises Invalid_argument

  if the index is invalid (> length buf).

Push value at the back of t. If t.bounded=false, the buffer will grow as needed, otherwise the oldest elements are replaced first.

First value from front of t, without modification.

First value from front of t, without modification.

• raises Empty

  if buffer is empty.

• since 1.3

Get the last value from back of t, without modification.

Get the last value from back of t, without modification.

• raises Empty

  if buffer is empty.

• since 1.3

Take and remove the last value from back of t, if any.

Take and remove the last value from back of t.

• raises Empty

  if buffer is already empty.

Take and remove the first value from front of t, if any.

Take and remove the first value from front of t.

• raises Empty

  if buffer is already empty.

Create a buffer from an initial array, but doesn't take ownership of it (still allocates a new internal array).

• since 0.11

Create an array from the elements, in order.

• since 0.11