Difference between revisions of "Buffer:trim"
From GiderosMobile
(Created page with "'''Available since:''' Gideros 2020.2<br/> '''Class:''' Buffer<br/> === Description === Removes data from the head or tail of a Buffer objec...") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
=== Description === | === Description === | ||
| − | Removes data from the head or tail of a | + | Removes data from the head or tail of a '''Buffer''' object. |
| − | + | <syntaxhighlight lang="lua"> | |
| − | < | ||
(number) = Buffer:trim(amount) | (number) = Buffer:trim(amount) | ||
| − | </ | + | </syntaxhighlight> |
| + | If ''amount'' is positive, data is removed from the beginning, otherwise data is removed from the end. | ||
=== Parameters === | === Parameters === | ||
| − | '''amount''': (number) | + | '''amount''': (number) amount of data to remove<br/> |
=== Return values === | === Return values === | ||
| − | '''Returns''' (number) | + | '''Returns''' (number) new buffer size<br/> |
{{Buffer}} | {{Buffer}} | ||
Latest revision as of 14:27, 13 July 2023
Available since: Gideros 2020.2
Class: Buffer
Description
Removes data from the head or tail of a Buffer object.
(number) = Buffer:trim(amount)
If amount is positive, data is removed from the beginning, otherwise data is removed from the end.
Parameters
amount: (number) amount of data to remove
Return values
Returns (number) new buffer size
