bson_writer_get_length man page

bson_writer_get_length() — Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written.

Synopsis

size_t
bson_writer_get_length (bson_writer_t *writer);

Parameters

writer
A bson_writer_t

Description

Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written.

This is useful if you want to check to see if you've passed a given memory boundry that cannot be sent in a packet. See bson_writer_rollback(3) to abort the current document being written.

Returns

The length of the underlying buffer.

Colophon

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐28 libbson