wslplugins_rs/plugin/mod.rs
1//! # WSL Plugin Framework
2//!
3//! This module serves as the main entry point for creating WSL plugins using Rust.
4//! It provides error handling, utilities, and the WSL Plugin v1 interface for seamless integration
5//! with the Windows Subsystem for Linux (WSL) plugin system.
6
7/// Error handling utilities for WSL plugins.
8///
9/// This module defines custom error types and result aliases to simplify and standardize
10/// error handling throughout the WSL plugin framework.
11pub mod error;
12
13/// The WSL Plugin v1 interface.
14///
15/// This module provides the implementation and traits required to define and interact with
16/// WSL plugins compatible with the Plugin API version 1.
17pub mod wsl_plugin_v1;
18
19/// Utility functions for WSL plugin development.
20///
21/// This module includes helper functions and utilities to facilitate common tasks in WSL plugin creation.
22pub mod utils;
23
24/// The primary error type for the WSL plugin framework.
25///
26/// Refer to [`error::Error`] for more details.
27pub use error::Error;
28
29/// A specialized result type for operations within the WSL plugin framework.
30///
31/// Refer to [`error::Result`] for more details.
32pub use error::Result;
33
34/// The core interface for WSL plugins.
35///
36/// Refer to [`wsl_plugin_v1::WSLPluginV1`] for more details.
37pub use wsl_plugin_v1::WSLPluginV1;
38
39/// A utility function to create a plugin with a specified required version.
40///
41/// Refer to [`utils::create_plugin_with_required_version`] for more details.
42pub use utils::create_plugin_with_required_version;