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:28:40 +08:00 committed by GitHub
parent 605d4fea04
commit 980810671c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -18,7 +18,8 @@ ByteArray.BIG_ENDIAN = 1
`create( [capacity, [endian]] )` Create an empty byte array. `create( [capacity, [endian]] )` Create an empty byte array.
`init( [param1, param2, ...] )` Create a byte array with initial bytes. Parameters should be a list of number or table. `init( [param1, param2, ...] )` Create a byte array with initial bytes. Parameters should be a list of number or table.
`load( str )` Create a byte array with lua string object for read data. This byte array is read-only. `load( str )` Create a byte array with lua string object for read data. This byte array is read-only.
return - A ByteArray object.
`return` A ByteArray object.
```lua ```lua
local x = ByteArray.create() -- create an empty byte array local x = ByteArray.create() -- create an empty byte array
@ -36,7 +37,8 @@ local z = ByteArray.load( "hello" ) -- create a byte array with a lua string obj
`readFloat()` Read a 32-bit float from byte array. `readFloat()` Read a 32-bit float from byte array.
`readDouble()` Read a 64-bit float from byte array. `readDouble()` Read a 64-bit float from byte array.
`readCString()` Read a string end with \0 from byte array. `readCString()` Read a string end with \0 from byte array.
return - data read
`return` data read
```lua ```lua
local buf = ByteArray.init( 1, 2, 3, 4, 5, 6 ) local buf = ByteArray.init( 1, 2, 3, 4, 5, 6 )
@ -55,7 +57,8 @@ local c = buf:readShort() -- c == 0x0403
`writeFloat( f32 )` Write a 32-bit float to byte array. `writeFloat( f32 )` Write a 32-bit float to byte array.
`writeDouble( f64 )` Write a 64-bit float to byte array. `writeDouble( f64 )` Write a 64-bit float to byte array.
`writeCString( str )` write a string end with \0 to byte array. `writeCString( str )` write a string end with \0 to byte array.
return - The ByteArray object itself.
`return` The ByteArray object itself.
```lua ```lua
local buf = ByteArray.create() local buf = ByteArray.create()
@ -66,6 +69,8 @@ buf:writeByte(1):writeByte(2):writeInt(0x0403)
`readBytes( to[, offset, length] )` Read data to first parameter(a ByteArray object), the range for the target byte array is start from offset with length. `readBytes( to[, offset, length] )` Read data to first parameter(a ByteArray object), the range for the target byte array is start from offset with length.
`writeBytes( from[, offset, length] )` Write data from first parameter(a ByteArray object), the range for the data is start from offset with length. `writeBytes( from[, offset, length] )` Write data from first parameter(a ByteArray object), the range for the data is start from offset with length.
`return` nil
```lua ```lua
local buf = ByteArray.init( 1, 2, 3, 4, 5 ) local buf = ByteArray.init( 1, 2, 3, 4, 5 )
local d = ByteArray.create() local d = ByteArray.create()