package containers

The module type of Array for this ring buffer

Defines the ring buffer type, with both bounded and unbounded flavors

Raised in querying functions when the buffer is empty

create ?bounded size creates a new buffer with given size. Defaults to bounded=false.

Make a fresh copy of the buffer.

Length of the inner buffer.

Maximum length of the inner buffer, or None if unbounded.

Number of elements currently stored in the buffer.

blit_from buf from_buf o len copies the slice o, ... o + len - 1 from a input buffer from_buf to the end of the buffer.

• 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

Extract the current content into a list

Clear the content of the buffer. Doesn't actually destroy the content.

Clear the content of the buffer, and also resize it to a default size

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, ie 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, ie 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.

• raises Empty

  if buffer is empty.

Get the last value from back of t.

• raises Empty

  if buffer is empty.

Take the last value from back of t, if any

Take the last value from back of t.

• raises Empty

  if buffer is already empty.

Take the first value from front of t, if any

Take 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 (stills allocates a new internal array)

• since 0.11

Create an array from the elements, in order.

• since 0.11