Andrew Phillips
9b7cbd5244
- Fix all 96 doctest failures across 20 files by adding hidden imports and proper test setup (68 pass, 33 intentionally ignored) - Fix set_item_tags: wrap in transaction and replace item.id.unwrap() with proper error handling - Fix get_items_matching: replace N+1 per-item meta queries with batch get_meta_for_items() call - Fix get_item_matching: apply meta filtering instead of ignoring the parameter - Remove duplicate doc comment in store_meta - Remove dead code files: plugin.rs, plugins.rs, binary_detection.rs (never declared as modules) - Apply cargo fmt formatting fixes - Add keep.db to .gitignore
77 lines
1.9 KiB
Rust
77 lines
1.9 KiB
Rust
#![deny(clippy::all)]
|
|
#![deny(unsafe_code)]
|
|
#![allow(unused_imports)]
|
|
|
|
//! Keep library for managing temporary files with compression and metadata.
|
|
//!
|
|
//! This library provides core functionality for the Keep application, including
|
|
//! database operations, compression engines, item services, and plugin systems
|
|
//! for metadata and filtering. It supports CLI modes, server APIs, and plugin
|
|
//! registration via ctors.
|
|
//!
|
|
//! # Usage
|
|
//!
|
|
//! Add to Cargo.toml and use re-exported types:
|
|
//! ```toml
|
|
//! [dependencies]
|
|
//! keep = "0.1"
|
|
//! ```
|
|
//!
|
|
//! ```rust
|
|
//! # use keep::Args;
|
|
//! # use clap::Parser;
|
|
//! let args = Args::parse();
|
|
//! ```
|
|
//!
|
|
//! # Features
|
|
//!
|
|
//! - `server`: Enables Axum-based HTTP server.
|
|
//! - `gzip`, `lz4`: Built-in compression support.
|
|
//! - `magic`: File type detection via libmagic.
|
|
|
|
// Re-export modules for testing
|
|
pub mod args;
|
|
pub mod common;
|
|
pub mod compression_engine;
|
|
pub mod config;
|
|
pub mod db;
|
|
pub mod filter_plugin;
|
|
pub mod meta_plugin;
|
|
pub mod modes;
|
|
pub mod services;
|
|
|
|
// Re-export Args struct for library usage
|
|
pub use args::Args;
|
|
// Re-export PIPESIZE constant
|
|
pub use common::PIPESIZE;
|
|
|
|
// Import all filter plugins to ensure they register themselves
|
|
#[allow(unused_imports)]
|
|
use filter_plugin::{grep, head, skip, strip_ansi, tail};
|
|
|
|
use crate::meta_plugin::{
|
|
cwd, digest, env, exec, hostname, keep_pid, read_rate, read_time, shell, shell_pid, user,
|
|
};
|
|
|
|
#[cfg(feature = "magic")]
|
|
#[allow(unused_imports)]
|
|
use crate::meta_plugin::magic_file;
|
|
|
|
/// Initializes plugins at library load time.
|
|
///
|
|
/// Ensures all filter and meta plugins are registered via their ctors.
|
|
/// Call this early in application startup if needed (though ctors handle most cases).
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```
|
|
/// keep::init_plugins();
|
|
/// ```
|
|
pub fn init_plugins() {
|
|
// This will be expanded in Step 3 implementation
|
|
// For now, the ctors handle registration
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests;
|