Update file documentation to clarify that reads are limited to LUAL_BUFFERSIZE bytes max

This commit is contained in:
Adam Bonner 2016-02-21 22:09:19 -08:00
parent 9970f8dc34
commit 0e770d95e7
1 changed files with 7 additions and 7 deletions

View File

@ -204,12 +204,12 @@ Read content from the open file.
#### Parameters #### Parameters
- `n_or_str`: - `n_or_str`:
- if nothing passed in, read all byte in file - if nothing passed in, read up to `LUAL_BUFFERSIZE` bytes (default 1024) or the entire file (whichever is smaller)
- if pass a number n, then read n bytes from file, or EOF is reached - if passed a number n, then read the file until the lesser of `n` bytes, `LUAL_BUFFERSIZE` bytes, or EOF is reached. Specifying a number larger than the buffer size will read the buffer size.
- if pass a string "str", then read until 'str' or EOF is reached - if passed a string `str`, then read until `str` appears next in the file, `LUAL_BUFFERSIZE` bytes have been read, or EOF is reached
#### Returns #### Returns
fdile content in string, or nil when EOF File content as a string, or nil when EOF
#### Example #### Example
```lua ```lua
@ -218,7 +218,7 @@ file.open("init.lua", "r")
print(file.read('\n')) print(file.read('\n'))
file.close() file.close()
-- print the first 5 byte of 'init.lua' -- print the first 5 bytes of 'init.lua'
file.open("init.lua", "r") file.open("init.lua", "r")
print(file.read(5)) print(file.read(5))
file.close() file.close()
@ -230,7 +230,7 @@ file.close()
## file.readline() ## file.readline()
Read the next line from the open file. Read the next line from the open file. Lines are defined as zero or more bytes ending with a EOL ('\n') byte. If the next line is longer than `LUAL_BUFFERSIZE`, this function only returns the first `LUAL_BUFFERSIZE` bytes (this is 1024 bytes by default).
#### Syntax #### Syntax
`file.readline()` `file.readline()`
@ -239,7 +239,7 @@ Read the next line from the open file.
none none
#### Returns #### Returns
File content in string, line by line, include EOL('\n'). Return `nil` when EOF. File content in string, line by line, including EOL('\n'). Return `nil` when EOF.
#### Example #### Example
```lua ```lua