crush-core 0.3.0

High-performance parallel compression library core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! Plugin system for Crush compression library
//!
//! This module provides the plugin infrastructure for extending Crush with
//! custom compression algorithms. Plugins are registered at compile-time using
//! the `linkme` crate for zero runtime overhead.

pub mod contract;
pub mod default;
pub mod metadata;
pub mod registry;
pub mod selector;
pub mod timeout;

pub use contract::CompressionAlgorithm;
pub use metadata::{CrushHeader, FileMetadata, PluginMetadata};
pub use registry::{init_plugins, list_plugins};
pub use selector::{calculate_plugin_score, PluginSelector, ScoringWeights};
pub use timeout::{run_with_timeout, run_with_timeout_and_cancel, TimeoutGuard};

use linkme::distributed_slice;

/// Global registry of all compile-time registered compression plugins
///
/// Plugins register themselves by adding to this distributed slice using:
/// ```
/// use crush_core::plugin::{CompressionAlgorithm, COMPRESSION_ALGORITHMS};
/// use linkme::distributed_slice;
///
/// // Plugin registration example (requires implementing CompressionAlgorithm)
/// // #[distributed_slice(COMPRESSION_ALGORITHMS)]
/// // static MY_PLUGIN: &dyn CompressionAlgorithm = &MyPluginImpl;
/// ```
#[distributed_slice]
pub static COMPRESSION_ALGORITHMS: [&'static dyn CompressionAlgorithm] = [..];