mirror of
https://github.com/neovim/neovim.git
synced 2025-09-24 20:18:32 +00:00
feat(api): implement nvim_buf_get_text (#15181)
nvim_buf_get_text is the mirror of nvim_buf_set_text. It differs from nvim_buf_get_lines in that it allows retrieving only portions of lines. While this can typically be done easily enough by API clients, implementing this function provides symmetry between the get/set text/lines APIs, and also provides a nice convenience that saves API clients the work of having to slice the result of nvim_buf_get_lines themselves.
This commit is contained in:
@@ -2152,6 +2152,29 @@ nvim_buf_get_option({buffer}, {name}) *nvim_buf_get_option()*
|
||||
Return: ~
|
||||
Option value
|
||||
|
||||
*nvim_buf_get_text()*
|
||||
nvim_buf_get_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col},
|
||||
{opts})
|
||||
Gets a range from the buffer.
|
||||
|
||||
This differs from |nvim_buf_get_lines()| in that it allows
|
||||
retrieving only portions of a line.
|
||||
|
||||
Indexing is zero-based. Column indices are end-exclusive.
|
||||
|
||||
Prefer |nvim_buf_get_lines()| when retrieving entire lines.
|
||||
|
||||
Parameters: ~
|
||||
{buffer} Buffer handle, or 0 for current buffer
|
||||
{start_row} First line index
|
||||
{start_col} Starting byte offset of first line
|
||||
{end_row} Last line index
|
||||
{end_col} Ending byte offset of last line (exclusive)
|
||||
{opts} Optional parameters. Currently unused.
|
||||
|
||||
Return: ~
|
||||
Array of lines, or empty array for unloaded buffer.
|
||||
|
||||
nvim_buf_get_var({buffer}, {name}) *nvim_buf_get_var()*
|
||||
Gets a buffer-scoped (b:) variable.
|
||||
|
||||
|
Reference in New Issue
Block a user