README
- ::outputShellError::output
- ::to_reprShellError::to_repr
- ::to_stringShellError::to_string
V
beep
V
ensure_supported
V
is_supported
V
open
V
reveal_item
V
trash_item

proton_shell

Native shell helpers for MoonBit.

shell

desktop

native

windows

Download zip

Author

moonbit-community

Version

0.7.0

License

Apache-2.0

Repository

github.com/moonbit-community/proton/tree/main/sys/shell

Last updated

2 days ago

Downloads

24K

moonbit-community/proton_shell does not have a README file

ShellError

source

pub suberror ShellError {
  ShellError(operation~ : String, target~ : String, reason~ : String)
} derive(@moonbitlang/core/debug.Debug
Debug)

A platform shell request could not be completed.

ShellError::output

source

fn ShellError::output(self : ShellError, logger : &Logger) -> Unit

ShellError::to_repr

source

fn ShellError::to_repr(ShellError) -> @moonbitlang/core/debug.Repr
Repr

ShellError::to_string

source

fn ShellError::to_string(self : ShellError) -> String

beep

source

fn beep() -> Result[Unit, String]

Plays the operating system's default alert sound.

On Windows this calls MessageBeep. On macOS and Linux it writes the terminal bell escape to stderr. Returns Ok(()) when the platform has a beep backend.

ensure_supported

source

fn ensure_supported() -> Result[Unit, String]

Verifies that the current native platform is supported by this package.

Returns Ok(()) on supported platforms and an explanatory Err(String) on unsupported targets.

is_supported

source

fn is_supported() -> Bool

Returns true when the current native target has a shell backend that this package knows how to call.

open

source

async fn open(target : String) -> Unit raise ShellError

Opens a URL or filesystem path with its default application.

Uses ShellExecuteW on Windows, /usr/bin/open on macOS, and gio open on Linux. Linux requires gio and a desktop session with a default handler. Raises ShellError on failure. Waiting for an external tool yields to other tasks; cancellation terminates and reaps the tool using async's process lifecycle. Success means the platform accepted the request, not that the target app finished starting.

reveal_item

source

async fn reveal_item(path : String) -> Unit raise ShellError

Opens the native file manager and selects the filesystem entry at path.

Uses Explorer on Windows, /usr/bin/open -R on macOS, and FileManager1 ShowItems via dbus-send on Linux. Linux requires dbus-send and a file manager implementing that session-bus interface. Raises ShellError on failure. External-tool waits yield and participate in task cancellation.

trash_item

source

async fn trash_item(path : String) -> Unit raise ShellError

Moves path to the operating-system trash or recycle bin.

Uses the recycle bin on Windows, Finder Trash on macOS, and gio trash on Linux. Raises ShellError on failure. The Linux tool wait yields and participates in task cancellation.