Network.ByteOrder

A pointer to Word8.

Offset from the current pointer.

Size of a buffer.

Buffer overrun exception.

Using ByteString as Buffer and call the IO action of the second argument by passing the start point and the offset of the ByteString. Note that if a ByteString is created newly, its offset is 0.

Copying the bytestring to the buffer. This function returns the point where the next copy should start.

>>> let buf = "abc" :: ByteString>>> unsafeWithByteString buf $ \ptr _ -> Network.ByteOrder.copy ptr "ABC" >> return buf"ABC"

Converting the part of buffer to ByteString and executing the action with it.

>>> let buf = "abcdef" :: ByteString>>> unsafeWithByteString buf $ \ptr _-> bufferIO ptr 2 return"ab"

Read only buffer. To ensure that the internal is not modified, this is an abstract data type.

Creating a read buffer with the given buffer.

Converting ByteString to ReadBuffer and run the action with it.

Reading two bytes as Word16 and ff two bytes.

>>> withReadBuffer "\x0\x1\x2\x3" $ read161

Reading three bytes as Word32 and ff three bytes.

>>> withReadBuffer "\x0\x1\x2\x3" $ read24258

Reading four bytes as Word32 and ff four bytes.

>>> withReadBuffer "\x0\x1\x2\x3" $ read3266051

Reading four bytes as Word64 and ff four bytes.

Extracting ByteString from the current offset. The contents is copied, not shared. Its length is specified by the 2nd argument. If the length is positive, the area after the current pointer is extracted and FF the length finally. If the length is negative, the area before the current pointer is extracted and does not FF.

>>> withReadBuffer "abcdefg" $ \rbuf -> ff rbuf 1 >> extractByteString rbuf 2"bc"

Extracting ShortByteString from the current offset. The contents is copied, not shared. Its length is specified by the 2nd argument. If the length is positive, the area after the current pointer is extracted and FF the length finally. If the length is negative, the area before the current pointer is extracted and does not FF.

>>> withReadBuffer "abcdefg" $ \rbuf -> ff rbuf 2 >> extractShortByteString rbuf 3"cde"

Read and write buffer.

Creating a write buffer with the given buffer.

Reseting a write buffer.

Allocate a temporary buffer and copy the result to ByteString.

Allocate a temporary buffer and copy the result to ByteString with an additional value.

>>> withWriteBuffer' 1 $ \wbuf -> write8 wbuf 65 >> return 'a'("A",'a')

Write one byte and ff one byte. If buffer overrun occurs, BufferOverrun is thrown.

>>> withWriteBuffer 1 $ \wbuf -> write8 wbuf 65"A"

Write two bytes and ff one byte. If buffer overrun occurs, BufferOverrun is thrown.

>>> withWriteBuffer 2 $ \wbuf -> write16 wbuf (65 * 256 + 66)"AB"

Write three bytes and ff one byte. If buffer overrun occurs, BufferOverrun is thrown.

>>> withWriteBuffer 3 $ \wbuf -> write24 wbuf (65 * 256^(2 :: Int) + 66 * 256 + 67)"ABC"

Write four bytes and ff one byte. If buffer overrun occurs, BufferOverrun is thrown.

>>> withWriteBuffer 4 $ \wbuf -> write32 wbuf (65 * 256^(3 :: Int) + 66 * 256^(2 :: Int) + 67 * 256 + 68)"ABCD"

Write four bytes and ff one byte. If buffer overrun occurs, BufferOverrun is thrown.

Copy the content of ByteString and ff its length. If buffer overrun occurs, BufferOverrun is thrown.

>>> withWriteBuffer 3 $ \wbuf -> copyByteString wbuf "ABC""ABC"

Copy the content of ShortByteString and ff its length. If buffer overrun occurs, BufferOverrun is thrown.

>>> withWriteBuffer 5 $ \wbuf -> copyShortByteString wbuf "ABCEF""ABCEF"

Shifting the N-bytes area just before the current pointer (the 3rd argument). If the second argument is positive, shift it to right. If it is negative, shift it to left. offset moves as if it is sticky to the area.

>>> withWriteBuffer 16 $ \wbuf -> copyByteString wbuf "ABCD" >> shiftLastN wbuf 1 3"ABBCD">>> withWriteBuffer 16 $ \wbuf -> copyByteString wbuf "ABCD" >> shiftLastN wbuf 2 3"ABCBCD">>> withWriteBuffer 16 $ \wbuf -> copyByteString wbuf "ABCDE" >> shiftLastN wbuf (-2) 3 >> ff wbuf 2"CDEDE"

Copy the area from start to the current pointer to ByteString.

Copy the area from start to the current pointer to ShortByteString.

Getting the offset pointer.

8-bit unsigned integer type

16-bit unsigned integer type

32-bit unsigned integer type

64-bit unsigned integer type

A space-efficient representation of a Word8 vector, supporting many efficient operations.

A ByteString contains 8-bit bytes, or by using the operations from Data.ByteString.Char8 it can be interpreted as containing 8-bit characters.