Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Web/API Feature Crates

oxidite-realtime

Main modules/exports:

  • SSE: SseEvent, SseStream, SseConfig
  • pub/sub: PubSub, Subscriber, Channel
  • event model: Event, EventType
  • websocket: WebSocketConnection, WebSocketManager, WsMessage, WebSocketError

oxidite-template

Main APIs:

  • TemplateEngine, Context, Template
  • parser/renderer modules
  • filters module
  • static files: StaticFiles, serve_static, static_handler

oxidite-openapi

Main APIs:

  • spec types: OpenApiSpec, Info, Server, PathItem, Operation, Parameter, RequestBody, Response, Schema, Components
  • builders/helpers: OpenApiBuilder, get_operation, post_operation
  • traits: ToSchema, AutoDocs
  • docs renderer: generate_docs_html

oxidite-graphql

Main APIs:

  • GraphQLSchema
  • Context
  • ResolverExtension, ResolverRegistry
  • GraphQLHandler
  • create_handler()

oxidite-mail

Main APIs:

  • Mailer
  • Message
  • SmtpTransport, SmtpConfig
  • Attachment

oxidite-plugin

Main APIs:

  • plugin model: Plugin, PluginInfo, PluginHook, HookResult
  • runtime: PluginLoader, PluginManager
  • setup: PluginConfig, create_manager