string: bring back the is_lit comment

pull/10661/head
Alexander Medvednikov 2021-07-03 20:16:49 +03:00
parent 0f9537ece5
commit 6a64259527
1 changed files with 6 additions and 0 deletions

View File

@ -45,6 +45,12 @@ pub struct string {
pub:
str &byte = 0 // points to a C style 0 terminated string of bytes.
len int // the length of the .str field, excluding the ending 0 byte. It is always equal to strlen(.str).
// NB string.is_lit is an enumeration of the following:
// .is_lit == 0 => a fresh string, should be freed by autofree
// .is_lit == 1 => a literal string from .rodata, should NOT be freed
// .is_lit == -98761234 => already freed string, protects against double frees.
// ---------> ^^^^^^^^^ calling free on these is a bug.
// Any other value means that the string has been corrupted.
mut:
is_lit int
}