Module p1_queue

.

Copyright © (C) 2017-2019 Evgeny Khramtsov

Authors: Evgeny Khramtsov (ekhramtsov@process-one.net).

Description

Data Types

error_reason()

error_reason() = p1_file_queue:error_reason()

fqueue()

fqueue() = p1_file_queue:queue()

limit()

limit() = non_neg_integer() | unlimited

queue()

queue(T) = rqueue(T) | fqueue()

queue()

queue() = rqueue(any()) | fqueue()

queue_type()

queue_type() = ram | file

rqueue()

rqueue(T) = {queue:queue(T), non_neg_integer(), limit()}

rqueue()

rqueue() = rqueue(any())

Function Index

clear/1
drop/1
dropwhile/2
file_to_ram/1
foldl/3
foreach/2
format_error/1
from_list/1
from_list/2
from_list/3
get_limit/1
in/2
is_empty/1
is_queue/1
len/1
new/0
new/1
new/2
out/1
peek/1
ram_to_file/1
set_limit/2
start/1
stop/0
to_list/1
type/1

Function Details

clear/1

clear(Q::rqueue(T)) -> rqueue(T)

drop/1

drop(Q::rqueue(T)) -> rqueue(T)

dropwhile/2

dropwhile(F::fun((T) -> boolean()), Q::rqueue(T)) -> rqueue(T)

file_to_ram/1

file_to_ram(Q::queue()) -> rqueue()

foldl/3

foldl(F::fun((T1, T2) -> T2), T2, Q::queue(T1)) -> T2

foreach/2

foreach(F::fun((T) -> term()), Q::queue(T)) -> ok

format_error/1

format_error(Reason::error_reason()) -> string()

from_list/1

from_list(L::[T]) -> rqueue(T)

from_list/2

from_list(L::[T], Type::ram) -> rqueue(T)

from_list/3

from_list(L::[T], X2::ram, Limit::limit()) -> rqueue(T)

get_limit/1

get_limit(Q::queue()) -> limit()

in/2

in(Item::term(), Q::rqueue(T)) -> rqueue(T)

is_empty/1

is_empty(Q::queue()) -> boolean()

is_queue/1

is_queue(Q::any()) -> boolean()

len/1

len(Q::queue()) -> non_neg_integer()

new/0

new() -> rqueue()

new/1

new(Type::ram) -> rqueue()

new/2

new(X1::ram, Limit::limit()) -> rqueue()

out/1

out(Q::rqueue(T)) -> {{value, term()}, rqueue(T)} | {empty, rqueue(T)}

peek/1

peek(Q::queue(T)) -> empty | {value, T}

ram_to_file/1

ram_to_file(Q::queue()) -> fqueue()

set_limit/2

set_limit(Q::rqueue(T), Limit::limit()) -> rqueue(T)

start/1

start(Dir::file:filename()) -> ok | {error, any()}

stop/0

stop() -> ok | {error, any()}

to_list/1

to_list(Q::queue(T)) -> [T]

type/1

type(Q::queue()) -> ram | {file, file:filename()}


Generated by EDoc, Aug 1 2020, 01:20:30.