nexusrpc API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • abc.ABC
    • nexusrpc.handler._core.AbstractHandler - No class docstring; 1/2 method documented
      • nexusrpc.handler._core.BaseServiceCollectionHandler - A Nexus handler, managing a collection of Nexus service handlers.
        • nexusrpc.handler.Handler - A Nexus handler manages a collection of Nexus service handlers.
    • nexusrpc.handler._core.BaseServiceCollectionHandler - A Nexus handler, managing a collection of Nexus service handlers.
      • nexusrpc.handler.Handler - A Nexus handler manages a collection of Nexus service handlers.
    • nexusrpc.handler.MiddlewareSafeOperationHandler - An OperationHandler where start and cancel can be awaited by an async runtime. It can produce a result synchronously by returning StartOperationResultSync or asynchronously by returning StartOperationResultAsync...
      • nexusrpc.handler._core._EnsuredAwaitableOperationHandler - An AwaitableOperationHandler that wraps an OperationHandler and uses an _Executor to ensure that the start and cancel methods are awaitable.
    • nexusrpc.handler.OperationContext - Context for the execution of the requested operation method.
      • nexusrpc.handler.CancelOperationContext - Context for the cancel method.
      • nexusrpc.handler.StartOperationContext - Context for the start method.
    • nexusrpc.handler.OperationHandler - Base class for an operation handler in a Nexus service implementation.
      • nexusrpc.handler._operation_handler.SyncOperationHandler - An OperationHandler that is limited to responding synchronously.
      • nexusrpc.handler.MiddlewareSafeOperationHandler - An OperationHandler where start and cancel can be awaited by an async runtime. It can produce a result synchronously by returning StartOperationResultSync or asynchronously by returning StartOperationResultAsync...
        • nexusrpc.handler._core._EnsuredAwaitableOperationHandler - An AwaitableOperationHandler that wraps an OperationHandler and uses an _Executor to ensure that the start and cancel methods are awaitable.
    • nexusrpc.handler.OperationHandlerMiddleware - Middleware for operation handlers.
    • nexusrpc.handler.OperationTaskCancellation - Indicates whether a a Nexus task has been cancelled during a sync operation or before an async operation has returned a token.
  • enum.Enum
    • nexusrpc.HandlerErrorType - Nexus handler error types.
    • nexusrpc.OperationErrorState - The state of an operation as described by an OperationError.
  • Exception
    • nexusrpc.HandlerError - A Nexus handler error.
    • nexusrpc.OperationError - An error that represents "failed" and "canceled" operation results.
  • nexusrpc.Content - A container for a map of headers and a byte array of data.
  • nexusrpc.handler._core._Executor - An executor for synchronous functions.
  • nexusrpc.handler._core.ServiceHandler - Internal representation of an instance of a user's service handler class.
  • nexusrpc.handler._operation_handler.OperationHandler
    • nexusrpc.handler._syncio.SyncOperationHandler - An nexusrpc.handler.OperationHandler that is limited to responding synchronously.
  • nexusrpc.handler.StartOperationResultAsync - A value returned by the start method of a nexus operation handler indicating that the operation is responding asynchronously.
  • nexusrpc.Link - A Link contains a URL and a type that can be used to decode the URL.
  • nexusrpc.ServiceDefinition - Internal representation of a user's service definition class.
  • typing.Generic
    • nexusrpc.handler.OperationHandler - Base class for an operation handler in a Nexus service implementation.
      • nexusrpc.handler._operation_handler.SyncOperationHandler - An OperationHandler that is limited to responding synchronously.
      • nexusrpc.handler.MiddlewareSafeOperationHandler - An OperationHandler where start and cancel can be awaited by an async runtime. It can produce a result synchronously by returning StartOperationResultSync or asynchronously by returning StartOperationResultAsync...
        • nexusrpc.handler._core._EnsuredAwaitableOperationHandler - An AwaitableOperationHandler that wraps an OperationHandler and uses an _Executor to ensure that the start and cancel methods are awaitable.
    • nexusrpc.handler.StartOperationResultSync - A result returned synchronously by the start method of a nexus operation handler.
    • nexusrpc.Operation - Defines a Nexus operation in a Nexus service definition.
    • nexusrpc.OperationDefinition - Internal representation of a user's Operation definition.
  • typing.Protocol
    • nexusrpc.LazyValueT - Undocumented
      • nexusrpc.LazyValue - A container for a value encoded in an underlying stream.
    • nexusrpc.Serializer - Serializer is used by the framework to serialize/deserialize input and output.
API Documentation for nexusrpc, generated by pydoctor 25.4.0 at 2025-12-08 23:10:12.