Struct ApiV1 

pub struct ApiV1(/* private fields */);

The ApiV1 struct provides an interface to interact with version 1 of the WSL Plugin API.

It encapsulates low-level interactions with the API and exposes a safe and idiomatic Rust interface. Represents a structured interface for interacting with the WSLPluginAPIV1 API.

This struct encapsulates the methods provided by the WSLPluginAPIV1 API, allowing idiomatic interaction with the Windows Subsystem for Linux (WSL).

Implementations

impl ApiV1

pub fn version(&self) -> &WSLVersion

Retpurns the current version of the WSL API being used.

This is useful for checking compatibility with specific API features.

Example

let api_v1: ApiV1 = ...;
let version = api_v1.version();
println!(
    "WSL API version: {}.{}.{}",
    version.Major, version.Minor, version.Revision
);

pub fn mount_folder<WP: AsRef<Path> + Debug, UP: AsRef<Utf8UnixPath> + Debug>( &self, session_id: SessionID, windows_path: WP, linux_path: UP, read_only: bool, name: &OsStr, ) -> WinResult<()>

Create plan9 mount between Windows & Linux Allows sharing a folder between the Windows host and the Linux environment.

Arguments

• session: The current WSL session.
• windows_path: The Windows path of the folder to be mounted.
• linux_path: The Linux path where the folder will be mounted.
• read_only: Whether the mount should be read-only.
• name: A custom name for the mount.

Errors

This function returns a windows error when the mount fails.

Example

api.mount_folder(&session, "C:\\path", "/mnt/path", false, "MyMount")?;

pub fn new_command<'a, P: IntoCowUtf8UnixPath<'a>>( &'a self, session_id: SessionID, program: P, ) -> WSLCommand<'a>

Creates a new WSLCommand associated with this API instance.

This is the preferred way to construct a command to be executed inside WSL. The returned WSLCommand is bound to:

• this API handle,
• the provided session,
• the specified Linux program path.

Parameters

• session_id: The WSL session in which the command will be executed.
• program: A Linux (UTF-8, Unix-style) path

Returns

A WSLCommand builder ready to be configured and executed.

Notes

• The default execution target is DistributionID::System.
• argv[0] defaults to the program path unless explicitly overridden.

Trait Implementations

impl AsRef<ApiV1> for WSLPluginAPIV1

fn as_ref(&self) -> &ApiV1

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<WSLPluginAPIV1> for ApiV1

fn as_ref(&self) -> &WSLPluginAPIV1

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for ApiV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ApiV1> for WSLPluginAPIV1

fn from(value: ApiV1) -> Self

Converts to this type from the input type.

impl From<WSLPluginAPIV1> for ApiV1

fn from(value: WSLPluginAPIV1) -> Self

Converts to this type from the input type.