Hint

Refer to QMK’s documentation for details on how to use community modules

generics

Generic types/functions.

OptionImpl(T)

Define a new option type.

Parameters:

• T – The type of values.

Option(T)

Expresive type for operations that may return nothing.

is_some: Whether this option contains a value.

Some(T, v)

Create an option with the given value.

None(T)

Create an empty option.

ResultImpl(T, E)

Define a new result type.

Parameters:

• T – The type of values.

• E – The type of errors.

Result(T, E)

Expresive type for operations that may fail.

is_ok: Whether this result is a value or error.

Ok(T, E, v)

Create a result with the given value.

Err(T, E, e)

Create a result instance with the given error.

unwrap(option_or_result)

Get the value out of an Ok/Some value, halt if Err/None

unwrap_err(result)

Get the error out of an Err value, halt if Ok

---

RingBufferImpl(T)

Define a new ring buffer type.

Parameters:

• T – The type of values.

RingBuffer(T)

Ring buffer type.

rbuf_from(T, buf)

Create a ring buffer around the given buffer.

Parameters:

• T – The type of values.

• buf – The buffer to wrap.

rbuf_push(rbuf, value)

Add an element.

rbuf_pop(rbuf)

Remove an element.

rbuf_has_data(rbuf)

Check emptiness.

rbuf_clear(rbuf)

Reset a buffer