wafer v0.1.0 Wafer.DLL.Rx

Bytewise reception buffer for our data link layer.

Link to this section Summary

Functions

Has the reception completed successfully?

Was there an error during reception?

Initialize a new empty buffer reading for receiving.

Receive a byte into the buffer.

Attempt to retrieve the received value from the buffer.

Link to this section Types

Link to this type

t()

t() :: %Wafer.DLL.Rx{buffer: binary(), state: any()}

Link to this section Functions

Link to this function

complete?(rx)

complete?(t()) :: boolean()

Has the reception completed successfully?

Link to this function

error?(rx)

error?(t()) :: boolean()

Was there an error during reception?

Initialize a new empty buffer reading for receiving.

Link to this function

rx(rx, byte)

rx(t(), byte()) :: t()

Receive a byte into the buffer.

Link to this function

value(rx)

value(t()) :: {:ok, any()} | {:error, any()}

Attempt to retrieve the received value from the buffer.