Skip to content

Class hal::stream_fill

ClassList > hal > stream_fill

Non-blocking callable for reading serial data into a buffer.

  • #include <streams.hpp>

Public Functions

Type Name
work_state state ()
stream_fill (std::span< hal::byte > p_buffer)
Construct a new fill object.
stream_fill (std::span< hal::byte > p_buffer, const size_t & p_fill_amount)
Construct a new fill object.

Public Functions Documentation

function state

work_state hal::stream_fill::state ()

function stream_fill [1/2]

Construct a new fill object. 

explicit hal::stream_fill::stream_fill (
    std::span< hal::byte > p_buffer
)

Parameters:

  • p_buffer - buffer to read data into

function stream_fill [2/2]

Construct a new fill object. 

hal::stream_fill::stream_fill (
    std::span< hal::byte > p_buffer,
    const size_t & p_fill_amount
)

Parameters:

  • p_buffer - buffer to read data into
  • p_fill_amount - reference to a size value to limit the fill amount by. 
    ## Friends Documentation

friend operator|

std::span< const hal::byte > hal::stream_fill::operator| (
    const std::span< const hal::byte > & p_input_data,
    stream_fill & p_self
)

The documentation for this class was generated from the following file libraries/include/libhal-util/streams.hpp