GitHub

TxDequeue

API reference for TxDequeue.

class TxDequeue[A, E]

The consuming side of a transactional queue.

Functions

take

take() -> Effect[A, E]

Returns Effect[A, E]

def take(self) -> Effect[A, E]: ...

poll

poll() -> Effect[Option[A]]

Returns Effect[Option[A]]

def poll(self) -> Effect[Option[A]]: ...

peek

peek() -> Effect[A, E]

Returns Effect[A, E]

def peek(self) -> Effect[A, E]: ...

take_all

take_all() -> Effect[Sequence[A], E]

Returns Effect[Sequence[A], E]

def take_all(self) -> Effect[Sequence[A], E]: ...

take_n

take_n(n) -> Effect[Sequence[A], E]
ParameterTypeDescription
nint

Returns Effect[Sequence[A], E]

def take_n(self, n: int) -> Effect[Sequence[A], E]: ...

take_between

take_between(minimum, maximum) -> Effect[Sequence[A], E]
ParameterTypeDescription
minimumint
maximumint

Returns Effect[Sequence[A], E]

def take_between(self, minimum: int, maximum: int) -> Effect[Sequence[A], E]: ...

size

size() -> Effect[int]

Returns Effect[int]

def size(self) -> Effect[int]: ...

is_empty

is_empty() -> Effect[bool]

Returns Effect[bool]

def is_empty(self) -> Effect[bool]: ...

is_non_empty

is_non_empty() -> Effect[bool]

Returns Effect[bool]

def is_non_empty(self) -> Effect[bool]: ...

is_full

is_full() -> Effect[bool]

Returns Effect[bool]

def is_full(self) -> Effect[bool]: ...

is_open

is_open() -> Effect[bool]

Returns Effect[bool]

def is_open(self) -> Effect[bool]: ...

is_closing

is_closing() -> Effect[bool]

Returns Effect[bool]

def is_closing(self) -> Effect[bool]: ...

is_done

is_done() -> Effect[bool]

Returns Effect[bool]

def is_done(self) -> Effect[bool]: ...

is_shutdown

is_shutdown() -> Effect[bool]

Returns Effect[bool]

def is_shutdown(self) -> Effect[bool]: ...

await_completion

await_completion() -> Effect[None]

Returns Effect[None]

def await_completion(self) -> Effect[None]: ...