istream_is_completed()

istream_is_completed()#

Checks if the given istream_h has completed its current reading operation. Completion is determined based on whether the defined criteria (e.g., reading up to a delimiter or a specific number of bytes) have been met.

Prototype

PUBLIC BOOL istream_is_completed(
    istream_h   istream
);

Parameters

Key

Type

Description

istream

istream_h

The handle to the istream to check for completion status.


Return Value

  • Returns TRUE if the istream’s operation (reading until a delimiter or a specific number of bytes) is complete.

  • Returns FALSE if the operation is not yet complete or if the istream is invalid.

Notes

  • The function checks the completed flag in the internal structure of the istream.

  • Logs an error if the provided istream is NULL.

Example Usage This function is typically used to verify whether an operation, such as reading a specific number of bytes or until a delimiter, has successfully completed before further processing.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples