GitHub

UnaryMethod

API reference for UnaryMethod.

class UnaryMethod[P, S, E, TE = RpcClientError]

Calls an RPC with a payload P: succeeds with S or fails with E or the client's transport error TE (an RpcClientError, or a cluster entity client's errors).

Functions

__init__

__init__(call) -> None
ParameterTypeDescription
callCallFn
def __init__(self, call: CallFn) -> None:
    self._call = call

__call__

__call__(payload: None = None, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None) -> Effect[S, E | TE]
__call__(payload: P, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None) -> Effect[S, E | TE]
ParameterTypeDescription
payload= None
headers= None
context= None
@overload
def __call__(
    self: UnaryMethod[None, S, E, TE],
    payload: None = None,
    /,
    *,
    headers: HeadersInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[S, E | TE]: ...
@overload
def __call__(
    self,
    payload: P,
    /,
    *,
    headers: HeadersInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[S, E | TE]: ...
def __call__(
    self,
    payload: object = None,
    /,
    *,
    headers: HeadersInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[Any, Any]:
    return self._call(payload, CallOptions(headers, context))

discard

discard(payload: None = None, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None) -> Effect[None, E | TE]
discard(payload: P, /, *, headers: HeadersInput | None = None, context: Context[Any] | None = None) -> Effect[None, E | TE]

Send the request and complete once the server acknowledges it as its handler starts, after the middleware ran (Effect's discard: true). The handler's result and error are not returned; transport errors, middleware errors and failures before the handler starts still fail the call. Over HTTP and workers it completes once the handler is done.

ParameterTypeDescription
payload= None
headers= None
context= None
@overload
def discard(
    self: UnaryMethod[None, S, E, TE],
    payload: None = None,
    /,
    *,
    headers: HeadersInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[None, E | TE]: ...
@overload
def discard(
    self,
    payload: P,
    /,
    *,
    headers: HeadersInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[None, E | TE]: ...
def discard(
    self,
    payload: object = None,
    /,
    *,
    headers: HeadersInput | None = None,
    context: Context[Any] | None = None,
) -> Effect[None, E | TE]:
    """Send the request and complete once the server acknowledges it as
    its handler starts, after the middleware ran (Effect's ``discard:
    true``). The handler's result and error are not returned; transport
    errors, middleware errors and failures before the handler starts
    still fail the call. Over HTTP and workers it completes once the
    handler is done."""
    return self._call(payload, CallOptions(headers, context, discard=True))