doc: clarify `length` param in `buffer.write` #32119

HarshithaKP · 2020-03-06T06:21:17Z

buffer.write documentation has an incaccuracy w.r.t the length parameter:
It says default number of bytes written is buf.length - offset. Change it to:
If the buffer has sufficient space from the offset, the string is written upto length.
If the buffer is short in space, only buf.length - offset bytes are written.

proof:

#node
> let buf = Buffer.alloc(10)
undefined
> buf
<Buffer 00 00 00 00 00 00 00 00 00 00>
> buf.write(‘abcd’, 3)
4
> buf
<Buffer 00 00 00 61 62 63 64 00 00 00>
> buf = Buffer.alloc(10)
<Buffer 00 00 00 00 00 00 00 00 00 00>
> buf.write(‘abcd’, 9)
1
> buf
<Buffer 00 00 00 00 00 00 00 00 00 61>
>

Refs : #32104 (comment)

Thanks to @addaleax for her suggestion in the above comment, that lead to this finding.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Make sure longer strings are written up to the buffer end Refs: nodejs#32119

doc/api/buffer.md

Make sure longer strings are written up to the buffer end Refs: #32119 PR-URL: #32123 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

addaleax · 2020-03-13T09:02:53Z

@HarshithaKP There are conflicts here, can you rebase against master?

`buffer.write` documentation has an incaccuracy w.r.t the `length` parameter: It says default number of bytes written is `buf.length - offset`. Change it to: If the buffer has sufficient space from the offset, the string is written upto `length`. If the buffer is short in space, only `buf.length - offset` bytes are written. Refs : nodejs#32104 (comment)

HarshithaKP · 2020-03-13T10:34:53Z

@addaleax, thanks. Rebased it. PTAL.

doc/api/buffer.md

Make sure longer strings are written up to the buffer end Refs: #32119 PR-URL: #32123 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

doc/api/buffer.md

`buffer.write` documentation has an incaccuracy w.r.t the `length` parameter: It says default number of bytes written is `buf.length - offset`. Change it to: If the buffer has sufficient space from the offset, the string is written upto `length`. If the buffer is short in space, only `buf.length - offset` bytes are written. Refs: #32104 (comment) PR-URL: #32119 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

addaleax · 2020-04-05T18:36:45Z

Landed in d03d9a0

`buffer.write` documentation has an incaccuracy w.r.t the `length` parameter: It says default number of bytes written is `buf.length - offset`. Change it to: If the buffer has sufficient space from the offset, the string is written upto `length`. If the buffer is short in space, only `buf.length - offset` bytes are written. Refs: #32104 (comment) PR-URL: #32119 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

Make sure longer strings are written up to the buffer end Refs: #32119 PR-URL: #32123 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

`buffer.write` documentation has an incaccuracy w.r.t the `length` parameter: It says default number of bytes written is `buf.length - offset`. Change it to: If the buffer has sufficient space from the offset, the string is written upto `length`. If the buffer is short in space, only `buf.length - offset` bytes are written. Refs: #32104 (comment) PR-URL: #32119 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Mar 6, 2020

HarshithaKP added a commit to HarshithaKP/node that referenced this pull request Mar 6, 2020

test: buffer.write with longer string scenario

2fdbb5e

Make sure longer strings are written up to the buffer end Refs: nodejs#32119

HarshithaKP mentioned this pull request Mar 6, 2020

test: buffer.write with longer string scenario #32123

Closed

4 tasks

BridgeAR reviewed Mar 9, 2020

View reviewed changes