Function esp_idf_sys::xStreamBufferBytesAvailable

source ยท
pub unsafe extern "C" fn xStreamBufferBytesAvailable(
    xStreamBuffer: StreamBufferHandle_t,
) -> usize
Expand description

@cond !DOC_EXCLUDE_HEADER_SECTION stream_buffer.h

@code{c} size_t xStreamBufferBytesAvailable( StreamBufferHandle_t xStreamBuffer ); @endcode @endcond

Queries a stream buffer to see how much data it contains, which is equal to the number of bytes that can be read from the stream buffer before the stream buffer would be empty.

@param xStreamBuffer The handle of the stream buffer being queried.

@return The number of bytes that can be read from the stream buffer before the stream buffer would be empty.

@cond !DOC_SINGLE_GROUP \defgroup xStreamBufferBytesAvailable xStreamBufferBytesAvailable @endcond \ingroup StreamBufferManagement