GitHub

API reference for Reader.

What a socket's reader gives: pull waits for the next non-empty batch of chunks; upgrade switches the connection to TLS.

Attributes

AttributeTypeDescription
pull= pull

Functions

__init__

__init__(pull, upgrade=unsupported_upgrade) -> None
ParameterTypeDescription
pullEffect[tuple[Chunk, ...], SocketError]
upgradeUpgrade = unsupported_upgrade
def __init__(
    self, pull: Effect[tuple[Chunk, ...], SocketError], upgrade: Upgrade = unsupported_upgrade
) -> None:
    require_effect(pull, "pull")
    self.pull = pull
    self._upgrade = upgrade

upgrade

upgrade(options=None) -> Effect[None, SocketError]
ParameterTypeDescription
optionsTlsUpgradeOptions | None = None

Returns Effect[None, SocketError]

def upgrade(self, options: TlsUpgradeOptions | None = None) -> Effect[None, SocketError]:
    return self._upgrade(options)