anod/lua-buffer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
anod221 2018-08-30 22:47:50 +08:00 committed by GitHub
parent 8a9a3c79b4
commit d090b325ab
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -27,6 +27,16 @@ local y = ByteArray.init( 0, 1, 2, 3 ) -- create a byte array with initial bytes
local z = ByteArray.load( "hello" ) -- create a byte array with a lua string object
```
# indexing
Index start from 1 to length. If out of range, return -1.
```lua
local buf = ByteArray.init(2,3)
print(buf[1]) -- 2
print(buf[2]) -- 3
print(buf[3]) -- -1
```
# reading data
`readByte()` Read a 8-bit signed integer from byte array.
`readUnsignedByte()` Read a 8-bit unsigned integer from byte array.
@ -138,13 +148,3 @@ Set / get endian.
local buf = ByteArray.init(2,3)
buf.endian = ByteArray.LITTLE_ENDIAN
```
# indexing
Index start from 1 to length. If out of range, return -1.
```lua
local buf = ByteArray.init(2,3)
print(buf[1]) -- 2
print(buf[2]) -- 3
print(buf[3]) -- -1
```