GitHub

API reference for Dequeue.

The consuming side of a queue.

Attributes

AttributeTypeDescription
capacityint | None

Functions

take

take() -> Effect[A, E]

Returns Effect[A, E]

def take(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]: ...

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

clear

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

Returns Effect[Sequence[A], E]

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

collect

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

Returns Effect[Sequence[A], E]

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

await_done

await_done() -> Effect[None, E]

Returns Effect[None, E]

def await_done(self) -> Effect[None, E]: ...

size

size() -> Effect[int]

Returns Effect[int]

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

is_full

is_full() -> Effect[bool]

Returns Effect[bool]

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