tarantool / tarantool/doc

`box_tuple_data` to get a pointer to the underlying MsgPack data.

Open
#5,166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Added new C function box_tuple_data to inspect raw MsgPack data. It is
similar to the box_tuple_to_buf but the former gives one an access to
the data pointer directly, not to a copy in a buffer. The 'bsize'
argument will be set to the box_tuple_bsize result if it is not NULL.

const char * box_tuple_data(box_tuple_t *tuple, size_t *bsize);

Requested by @LevKats in https://github.com/tarantool/tarantool/commit/31b4108862f38c6aecf57001aa4d1579f628176a.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the documentation for box_tuple_to_buf and related tuple APIs to find the appropriate C API reference location. Document box_tuple_data with its signature, direct MsgPack data pointer behavior, and the optional bsize result; done means the new function is described consistently with the existing API.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.