Module buffet
Common functions and constants.
Functions
| is_closed(bf) | Check whether a buffet object is closed. |
| get_iterator_error(bf) | Get an error returned by an iterator function (if present). |
| get_send_buffer(bf) | Get a send buffer. |
| get_sent_data(bf) | Get the entire content of a send buffer as a string. |
Fields
| _VERSION | A version of the library. |
Functions
- is_closed(bf)
-
Check whether a buffet object is closed.
Parameters:
- bf buffet the buffet object
Returns:
-
boolean
true if the buffet object is closed
- get_iterator_error(bf)
-
Get an error returned by an iterator function (if present).
Parameters:
- bf buffet the buffet object
Returns:
-
the error value
Or
-
nil
- get_send_buffer(bf)
-
Get a send buffer.
The function returns a reference to the buffer table, not a copy.
Parameters:
- bf buffet the buffet object
Returns:
-
table
the send buffer
- get_sent_data(bf)
-
Get the entire content of a send buffer as a string.
This function is a shortcut for
table.concat(get_send_buffer(bf)).Parameters:
- bf buffet the buffet object
Returns:
-
string
the content of the send buffer