Pipe.peek

Read from the default message but do not modify the internal offset. Consecutive calls to peek() will return portions of the message starting at the same position.

size_t peek(ubyte* output, size_t length, size_t offset, message_id msg)
struct Pipe
const
size_t
peek
(
ubyte* output
,
size_t length
,
size_t offset
,
message_id msg = DEFAULT_MESSAGE
)
size_t peek(ubyte[] output, size_t offset, message_id msg)
size_t peek(ubyte output, size_t offset, message_id msg)

Parameters

output ubyte*: the ubyte array to write the peeked message part to
length size_t: the length of the ubyte array output
offset size_t: the offset from the current position in message
msg message_id: the number identifying the message to peek from

Return Value

Type: size_t

number of bytes actually peeked and written into output

Pipe.peek

Parameters

Return Value

Meta

Source