diff --git a/README.md b/README.md index 5d47007..766097b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ # lua-buffer -AS3 ByteArray class for lua. +AS3 ByteArray module for lua. -# usage -add the module: +# usage: +To add this module to lvm, call luaopen_bytearr when initialize the lua aux lib. ```lua luaopen_bytearr(L); ``` # constant -ByteArray.LITTLE_ENDIAN - 0 -ByteArray.BIG_ENDIAN - 1 +```lua +ByteArray.LITTLE_ENDIAN = 0 +ByteArray.BIG_ENDIAN = 1 +``` # constructor -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. -load( str ) - Create a byte array with lua string object for read data. This byte array is read-only. +`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. +`load( str )` Create a byte array with lua string object for read data. This byte array is read-only. return - A ByteArray object. ```lua @@ -25,15 +27,15 @@ local z = ByteArray.load( "hello" ) -- create a byte array with a lua string obj ``` # method for read data -readByte() - Read a 8-bit signed integer from byte array. -readUnsignedByte() - Read a 8-bit unsigned integer from byte array. -readShort() - Read a 16-bit signed integer from byte array. -readUnsignedShort() - Read a 16-bit unsigned integer from byte array. -readInt() - Read a 32-bit signed integer from byte array. -readUnsignedInt() - Read a 32-bit unsigned integer from byte array. -readFloat() - Read a 32-bit float from byte array. -readDouble() - Read a 64-bit float from byte array. -readCString() - Read a string end with \0 from byte array. +`readByte()` Read a 8-bit signed integer from byte array. +`readUnsignedByte()` Read a 8-bit unsigned integer from byte array. +`readShort()` Read a 16-bit signed integer from byte array. +`readUnsignedShort()` Read a 16-bit unsigned integer from byte array. +`readInt()` Read a 32-bit signed integer from byte array. +`readUnsignedInt()` Read a 32-bit unsigned integer from byte array. +`readFloat()` Read a 32-bit float from byte array. +`readDouble()` Read a 64-bit float from byte array. +`readCString()` Read a string end with \0 from byte array. return - data read ```lua @@ -44,15 +46,15 @@ local c = buf:readShort() -- c == 0x0403 ``` # method for write data -writeByte( s8 ) - Write a 8-bit signed integer to byte array. -writeUnsignedByte( u8 ) - Write a 8-bit unsigned integer to byte array. -writeShort( s16 ) - Write a 16-bit signed integer to byte array. -writeUnsignedShort( u16 ) - Write a 16-bit unsigned integer to byte array. -writeInt( s32 ) - Write a 32-bit signed integer to byte array. -writeUnsignedInt( u32 ) - Write a 32-bit unsigned integer to byte array. -writeFloat( f32 ) - Write a 32-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. +`writeByte( s8 )` Write a 8-bit signed integer to byte array. +`writeUnsignedByte( u8 )` Write a 8-bit unsigned integer to byte array. +`writeShort( s16 )` Write a 16-bit signed integer to byte array. +`writeUnsignedShort( u16 )` Write a 16-bit unsigned integer to byte array. +`writeInt( s32 )` Write a 32-bit signed integer to byte array. +`writeUnsignedInt( u32 )` Write a 32-bit unsigned integer to byte array. +`writeFloat( f32 )` Write a 32-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. return - The ByteArray object itself. ```lua @@ -61,8 +63,8 @@ buf:writeByte(1):writeByte(2):writeInt(0x0403) ``` # method for copying data between ByteArray object -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. +`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. ```lua local buf = ByteArray.init( 1, 2, 3, 4, 5 )