wslplugins-rs 0.1.0-beta.4

A Rust framework for developing WSL plugins using safe and idiomatic Rust.
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

use std::net::TcpStream;

use crate::api::errors::Result as ApiResult;
#[cfg(doc)]
use crate::{api::Error as ApiError, DistributionID, WSLVersionCapability};
pub trait WSLCommandExecution {
    /// Executes the command via the underlying WSL Plugin API.
    ///
    /// On success, returns a [`TcpStream`] connected to the process' stdin/stdout.
    ///
    /// # Behavior
    ///
    /// - `argv[0]` is computed as:
    ///   - overridden `arg0` if set,
    ///   - otherwise the program path string.
    /// - The full argv passed to the API is:
    ///   `argv[0]` + all user-provided args.
    /// - The selected execution method depends on [`DistributionID`].
    /// - For `WSLCommand` and `PreparedWSLCommand`, a user distribution target
    ///   uses `ExecuteBinaryInDistribution`, which requires
    ///   [`WSLVersionCapability::ExecuteBinaryInDistribution`] (`2.1.2`).
    ///
    /// # Errors
    ///
    /// Returns an [`ApiError`] if the underlying API call fails, including when
    /// the `ExecuteBinaryInDistribution` command path is selected on an API
    /// version that does not support it.
    fn execute(&self) -> ApiResult<TcpStream>;
}