Editing Module:Buffer/doc (section)

====Buffer:_====
{{luaself|:_|args='string'|args2=value, pos, raw|args3=value, raw}}
{{hatnote|See also {{luaself|:stream|plain=y}} for a faster, simpler version of this op.}}

Appends a value to the Buffer. In rough terms, {{code|lang=lua|Buffer:_'string1':_'string2'}} is the same as {{code|lang=lua|Buffer {{=}} Buffer..'string1'..'string2'}}. (It may help to imagine {{code|:_}} as a {{code|..}} that has stood up and is now casting a shadow.)
{{anchor|valid|invalid|no-op}}

If passed an ''invalid'' {{code|value}} listed below, this is a no-op:
* {{luaref|boolean||y}}
* {{luaref|nil||y}}
* empty {{luaref|string||y}}, or any table such that {{luaref|tostring|args=table}} returns an empty string (or nil/false)
* {{luaref|table||y}} without a __tostring metamethod and which {{code|table[1]|lang=lua}} is nil or false

A table with no __tostring will pass through {{luaref|table.concat}} before insertion. An {{luaref|error|plain=y}} may be thrown if the table would cause table.concat to error. (Use {{luaself|:_all}} instead for such tables.)

When passed {{code|pos}} of type {{luaref|number|plain=y}}, the argument is identical to ''pos'' for {{luaref|table.insert|args=table, pos, value}}. In fact, assuming a [[#valid|valid value]], {{luaself|:_|args='string', 1}} is exactly the same as {{luaref|table.insert|args=Buffer, 1, 'string'}}.

Just like with the position arguments of [[#Buffer|Buffer()]], any ''pos'' of type {{luaref|string|plain=y}} would be treated as relative to length.
{{anchor|raw}}

Set {{code|raw}} to true to force append a ''value'' without tostring coercion, including [[#no-op|invalid]] values. If given only two (non-self) arguments with the second being a boolean, then the second is read as ''raw'' instead.