API Reference

This section provides comprehensive API documentation for all public classes, functions, and modules in litestar-storages. The documentation is automatically generated from source code docstrings.

Note

All storage backends implement the Storage protocol, ensuring consistent behavior across different providers.

Quick Navigation

Core Types

• Storage - Protocol defining the storage interface

• BaseStorage - Abstract base class for backends

• StoredFile - File metadata dataclass

• UploadResult - Upload operation result

Storage Backends

• MemoryStorage - In-memory (testing/development)

• FileSystemStorage - Local filesystem

• S3Storage - Amazon S3 and S3-compatible services

• GCSStorage - Google Cloud Storage

• AzureStorage - Azure Blob Storage

Litestar Integration

• StoragePlugin - Litestar plugin

• provide_storage() - DI utilities

• StoredFileDTO - Response DTOs

Exceptions

• StorageError - Base exception

• StorageFileNotFoundError - File not found

• StoragePermissionError - Permission denied

• ConfigurationError - Invalid configuration

Module Reference

• Base Classes
• Types
• Exceptions
• Storage Backends
  • Memory Storage
  • FileSystem Storage
  • S3 Storage
  • GCS Storage
  • Azure Storage
• Litestar Integration
  • Storage Plugin
  • Dependencies
  • DTOs