GitHub

TxEnqueue

API reference for TxEnqueue.

class TxEnqueue[A, E]

The producing side of a transactional queue.

Functions

offer

offer(item) -> Effect[bool]
ParameterTypeDescription
itemA

Returns Effect[bool]

def offer(self, item: A) -> Effect[bool]: ...

offer_all

offer_all[T](items) -> Effect[list[T]]
ParameterTypeDescription
itemsIterable[T]

Returns Effect[list[T]]

def offer_all[T](self: TxEnqueue[T, Any], items: Iterable[T]) -> Effect[list[T]]: ...

fail

fail(error) -> Effect[bool]
ParameterTypeDescription
errorE

Returns Effect[bool]

def fail(self, error: E) -> Effect[bool]: ...

fail_cause

fail_cause(cause) -> Effect[bool]
ParameterTypeDescription
causeCause[E]

Returns Effect[bool]

def fail_cause(self, cause: Cause[E]) -> Effect[bool]: ...

end

end() -> Effect[bool]

Returns Effect[bool]

def end(self: TxEnqueue[Any, Done]) -> Effect[bool]: ...

interrupt

interrupt() -> Effect[bool]

Returns Effect[bool]

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

shutdown

shutdown() -> Effect[bool]

Returns Effect[bool]

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

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]: ...