GitHub

API reference for layers.

Ready-made DevTools layers (Effect's devtools/DevTools): every span is reported to the DevTools at ws://localhost:34437 by default.

Values

AttributeTypeDescription
DEFAULT_URLLiteral['ws://localhost:34437'] = 'ws://localhost:34437'
layer_socketLayer[Never, Never, Socket]

Reports spans over the Socket provided.

Functions

layer_web_socket

layer_web_socket(url=DEFAULT_URL) -> Layer[Never, Never, WebSocketConstructor]

Reports spans over a WebSocket to url.

ParameterTypeDescription
urlstr = DEFAULT_URL

Returns Layer[Never, Never, WebSocketConstructor]

def layer_web_socket(url: str = DEFAULT_URL) -> Layer[Never, Never, WebSocketConstructor]:
    """Reports spans over a WebSocket to ``url``."""
    return layer_tracer.pipe(layer_provide(socket_layer_web_socket(url)))

layer

layer(url=DEFAULT_URL) -> Layer[Never]

Reports spans over a WebSocket to url, opened with the websockets client (the websockets extra).

ParameterTypeDescription
urlstr = DEFAULT_URL

Returns Layer[Never]

def layer(url: str = DEFAULT_URL) -> Layer[Never]:
    """Reports spans over a WebSocket to ``url``, opened with the
    ``websockets`` client (the ``websockets`` extra)."""
    from pyfect.socket.ws import layer_web_socket_constructor

    return layer_web_socket(url).pipe(layer_provide(layer_web_socket_constructor))