builtin: document the rune.length_in_bytes method (#13826)

2022-03-25 18:09:39 +00:00 · 2022-03-25 18:09:39 +00:00 · ea4410cdb5
parent 347db755c8
commit ea4410cdb5
1 changed files with 2 additions and 0 deletions
--- a/vlib/builtin/rune.v
+++ b/vlib/builtin/rune.v
@ -61,6 +61,8 @@ pub fn (c rune) bytes() []byte {
 	return res
 }

+// length_in_bytes returns the number of bytes needed to store the code point.
+// Returns -1 if the data is not a valid code point.
 pub fn (c rune) length_in_bytes() int {
 	code := u32(c)
 	if code <= 0x7F {