class StreamMethod[P, A, E, TE = RpcClientError]
Calls a streaming RPC with a payload P: a stream of A items
failing with E or the client's transport error TE. With as_queue=True it
is a scoped queue of the items instead.
Functions#
__init__#
__init__(open) -> None| Parameter | Type | Description |
|---|---|---|
open | StreamFn |
def __init__(self, open: StreamFn) -> None:
self._open = open__call__#
__call__(payload: None = None, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None, stream_buffer_size: int = 16, as_queue: Literal[False] = False) -> Stream[A, E | TE]
__call__(payload: P, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None, stream_buffer_size: int = 16, as_queue: Literal[False] = False) -> Stream[A, E | TE]
__call__(payload: None = None, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None, stream_buffer_size: int = 16, as_queue: Literal[True]) -> Effect[Dequeue[A, E | TE | Done], Never, Scope]
__call__(payload: P, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None, stream_buffer_size: int = 16, as_queue: Literal[True]) -> Effect[Dequeue[A, E | TE | Done], Never, Scope]| Parameter | Type | Description |
|---|---|---|
payload | = None | |
headers | = None | |
context | = None | |
stream_buffer_size | = 16 | |
as_queue | = False |
@overload
def __call__(
self: StreamMethod[None, A, E, TE],
payload: None = None,
/,
*,
headers: HeadersInput | None = None,
context: Context[Any] | None = None,
stream_buffer_size: int = 16,
as_queue: Literal[False] = False,
) -> Stream[A, E | TE]: ...
@overload
def __call__(
self,
payload: P,
/,
*,
headers: HeadersInput | None = None,
context: Context[Any] | None = None,
stream_buffer_size: int = 16,
as_queue: Literal[False] = False,
) -> Stream[A, E | TE]: ...
@overload
def __call__(
self: StreamMethod[None, A, E, TE],
payload: None = None,
/,
*,
headers: HeadersInput | None = None,
context: Context[Any] | None = None,
stream_buffer_size: int = 16,
as_queue: Literal[True],
) -> Effect[Dequeue[A, E | TE | Done], Never, Scope]: ...
@overload
def __call__(
self,
payload: P,
/,
*,
headers: HeadersInput | None = None,
context: Context[Any] | None = None,
stream_buffer_size: int = 16,
as_queue: Literal[True],
) -> Effect[Dequeue[A, E | TE | Done], Never, Scope]: ...
def __call__(
self,
payload: object = None,
/,
*,
headers: HeadersInput | None = None,
context: Context[Any] | None = None,
stream_buffer_size: int = 16,
as_queue: bool = False,
) -> Any:
from pyfect.stream import from_queue, scoped, unwrap
options = CallOptions(headers, context, stream_buffer_size=stream_buffer_size)
opened = self._open(payload, options)
if as_queue:
return opened
return scoped(unwrap(opened.map(from_queue)))