GitHub

API reference for Enqueue.

The producing side of a queue.

Functions

offer

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

Returns Effect[bool]

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

offer_all

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

Returns Effect[list[T]]

def offer_all[T](self: Enqueue[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: Enqueue[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]: ...

into

into(eff) -> Effect[bool, Never, R]
ParameterTypeDescription
effEffect[object, E, R]

Returns Effect[bool, Never, R]

def into[R](self: Enqueue[Any, Done], eff: Effect[object, E, R]) -> Effect[bool, Never, R]: ...