reovim-driver-codec 0.14.4

Content codec driver for reovim (trait definitions only)
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

#![cfg_attr(coverage_nightly, allow(unused_features))]
#![cfg_attr(coverage_nightly, feature(coverage_attribute))]
//! Content codec driver for reovim.
//!
//! This crate defines the trait interface for content encoding and decoding.
//! It does NOT depend on any specific encoding library (e.g., `encoding_rs`).
//! Those are implementation details of codec modules (`server/modules/codec-*/`).
//!
//! # Design Philosophy
//!
//! This crate follows the Linux kernel "mechanism vs policy" principle:
//!
//! - **Driver provides MECHANISM**: The traits and stores define HOW codecs
//!   are registered, discovered, and invoked.
//! - **Modules provide POLICY**: Codec modules decide WHAT encodings to support
//!   and HOW to detect/decode/encode them.
//!
//! # Architecture
//!
//! ```text
//! server/lib/drivers/codec/               <-- Traits, stores, types
//!        ^
//!        |  implements
//!        |
//! server/modules/codec-utf8/             <-- UTF-8 codec
//! server/modules/codec-hex/              <-- Hex dump codec
//! server/modules/codec-cjk/              <-- CJK encoding codecs
//! server/modules/codec-legacy/           <-- Legacy encoding codecs
//! ```
//!
//! # Components
//!
//! - [`ContentCodec`] — Decode raw bytes to text, encode text back to bytes
//! - [`ContentClassifier`] — Detect content type from raw bytes
//! - [`ContentCodecFactory`] — Create codec instances for content types
//! - [`ContentCodecFactoryStore`] — Service registry for codec factories
//! - [`ContentClassifierStore`] — Service registry for classifiers
//! - [`CodecSessionState`] — Per-buffer codec metadata (session extension)
//! - [`ContentType`] — Content type identifier
//! - [`CodecMetadata`] — Round-trip encoding metadata
//! - [`DecodeResult`] — Result of decoding (content + annotations + metadata)
//! - [`CodecError`] — Error type for codec operations

// ============================================================================
// Modules
// ============================================================================

mod classifier;
mod codec;
mod content_type;
mod error;
mod factory;
mod metadata;
mod state;
mod store;

// ============================================================================
// Re-exports
// ============================================================================

// Core traits
pub use {
    classifier::ContentClassifier,
    codec::ContentCodec,
    factory::ContentCodecFactory,
    store::{ContentClassifierStore, ContentCodecFactoryStore},
};

// Types
pub use {
    codec::DecodeResult, content_type::ContentType, error::CodecError, metadata::CodecMetadata,
};

// Per-session state
pub use state::CodecSessionState;