Crate openserve

Source
Expand description

§OpenServe Library

This is the core library for OpenServe, an AI-enhanced, cloud-native file server. It encapsulates all the core functionalities, including the server, services, models, and utilities. By organizing the project as a library, we ensure modularity, reusability, and testability.

§Modules

The library is structured into the following modules:

  • ai: Handles all AI-related features, including integration with OpenAI.
  • config: Defines the configuration structures and loading mechanisms.
  • handlers: Contains all Axum HTTP request handlers.
  • middleware: Provides custom Axum middleware for logging, auth, etc.
  • models: Defines the data models and structures for the application.
  • server: Contains the main server implementation and setup.
  • services: Implements the business logic for file operations, search, etc.
  • telemetry: Configures and initializes logging, metrics, and tracing.
  • utils: Provides utility functions used across the application.

Re-exports§

pub use config::Config;
pub use server::Server;

Modules§

ai
AI Module - Complete Implementation
config
Configuration Module
error
Error Handling Module
handlers
Handlers Module
middleware
Middleware Module
models
Models Module
prelude
A prelude module for easy importing of common types.
server
Server Module
services
Services Module
telemetry
Telemetry Module
utils
Utilities Module

Macros§

auth_error
A helper macro for creating AuthError variants of AppError.
fs_error
A helper macro for creating FileSystemError variants of AppError.
validation_error
A helper macro for creating ValidationError variants of AppError.

Structs§

Args
Command-line arguments for OpenServe server.

Constants§

VERSION
The current version of the OpenServe application, read from Cargo.toml.