Skip to content

Class hal::stream_find

ClassList > hal > stream_find

Discard received bytes until the sequence is found.

  • #include <streams.hpp>

Public Functions

Type Name
work_state state ()
stream_find (std::span< const hal::byte > p_sequence)
Construct a new find object.

Public Functions Documentation

function state

work_state hal::stream_find::state ()

function stream_find

Construct a new find object. 

explicit hal::stream_find::stream_find (
    std::span< const hal::byte > p_sequence
)

Parameters:

  • p_sequence - sequence to search for. The lifetime of this data pointed to by this span must outlive this object, or not be used when the lifetime of that data is no longer available. 
    ## Friends Documentation

friend operator|

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

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