Binary

v0.0.5

Binary v0.0.5 Binary.Queue View Source

Queue for binary data.

It resembles a pipeline: data is pushed on one end and pulled from the other. The order by which bytes are pushed in is the same by which they are pulled out.

Internally, this queue implementation optimizes on the amount of copying of binary data in memory. Copying possibly occurs when binary data is pulled from the queue.

Examples

iex> Binary.Queue.new() |> Binary.Queue.push(<<5, 208, 224, 23, 85>>) %Binary.Queue{data: {[<<5, 208, 224, 23, 85>>],[]}, size: 5}

iex> Binary.Queue.new() |> Binary.Queue.push(<<5, 208, 224, 23, 85>>) |> Binary.Queue.pull(4) {<<5, 208, 224, 23>> , %Binary.Queue{data: {[],[“U”]}, size: 1}}

iex> Binary.Queue.new() |> Binary.Queue.push(<<5, 208, 224, 23, 85>>) |> Binary.Queue.push(<<82, 203>>) %Binary.Queue{data: {[<<82, 203>>],[<<5, 208, 224, 23, 85>>]}, size: 7}

Link to this section Summary

Types

t()

Functions

is_empty(queue)

Returns the amount of bytes on the queue

len(queue)

Returns the amount of bytes on the queue

new()

Returns a new empty binary queue

pull(queue)

Pulls a single byte from the queue. Returns a tuple of the first byte and the new queue without that first byte

pull(queue, amount)

Pulls a number of bytes from the queue. Returns a tuple of the first byte and the new queue without that first byte

push(queue, data)

Push binary data on the queue. Returns a new queue containing the pushed binary data

Link to this section Types

Link to this section Functions

Link to this function is_empty(queue) View Source 
is_empty(%Binary.Queue{data: term(), size: term()}) :: boolean()

Returns the amount of bytes on the queue

Examples

iex> q = Binary.Queue.new() %Binary.Queue{data: {[],[]}, size: 0} iex> Binary.Queue.is_empty(q) true iex> q = Binary.Queue.push(q, <<23, 75, 17>>) %Binary.Queue{data: {[<<23, 75, 17>>],[]}, size: 3} iex> Binary.Queue.is_empty(q) false

Link to this function len(queue) View Source 
len(%Binary.Queue{data: term(), size: term()}) :: non_neg_integer()

Returns the amount of bytes on the queue

Examples

iex> q = Binary.Queue.push(Binary.Queue.new(), <<23, 75, 17>>) %Binary.Queue{data: {[<<23, 75, 17>>],[]}, size: 3} iex> Binary.Queue.len(q) 3

Link to this function new() View Source 
new() :: t()

Returns a new empty binary queue.

Examples

iex> Binary.Queue.new() %Binary.Queue{data: {[],[]}, size: 0}

Link to this function pull(queue) View Source 
pull(t()) :: {binary(), t()}

Pulls a single byte from the queue. Returns a tuple of the first byte and the new queue without that first byte.

Examples

iex> q = Binary.Queue.push(Binary.Queue.new(), <<23, 75>>) %Binary.Queue{data: {[<<23, 75>>],[]}, size: 2} iex> Binary.Queue.pull(q) {<<23>>, %Binary.Queue{data: {[], [“K”]}, size: 1}}

Link to this function pull(queue, amount) View Source 
pull(t(), non_neg_integer()) :: {binary(), t()}

Pulls a number of bytes from the queue. Returns a tuple of the first byte and the new queue without that first byte.

Examples

iex> q = Binary.Queue.push(Binary.Queue.new(), <<23, 75, 17>>) %Binary.Queue{data: {[<<23, 75, 17>>],[]}, size: 3} iex> Binary.Queue.pull(q, 2) {<<23, 75>>, %Binary.Queue{data: {[], [<<17>>]}, size: 1}}

Link to this function push(queue, data) View Source 
push(t(), binary()) :: t()

Push binary data on the queue. Returns a new queue containing the pushed binary data.

Examples

iex> Binary.Queue.push(Binary.Queue.new(), <<23, 75>>) %Binary.Queue{data: {[<<23, 75>>],[]}, size: 2}