chore: update documentation

This commit is contained in:
Lucas Nogueira
2026-09-22 11:30:47 -03:00
parent d869c162a7
commit a87a3c7d44
104 changed files with 4875 additions and 222 deletions
+13
View File
@@ -4,25 +4,38 @@
use serde::{ser::Serializer, Serialize};
/// Alias for a [`Result`](std::result::Result) with the error type [`Error`].
pub type Result<T> = std::result::Result<T, Error>;
/// The error type for this plugin.
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// The requested operation (usually registering or unregistering a protocol scheme at
/// runtime) is not supported on the current platform.
#[error("unsupported platform")]
UnsupportedPlatform,
/// Transparent wrapper around an [`std::io::Error`].
#[error(transparent)]
Io(#[from] std::io::Error),
/// Transparent wrapper around a [`tauri::Error`].
#[error(transparent)]
Tauri(#[from] tauri::Error),
/// Transparent wrapper around a [`windows_result::Error`]. Only used on Windows.
#[cfg(target_os = "windows")]
#[error(transparent)]
Windows(#[from] windows_result::Error),
/// Transparent wrapper around an [`ini::Error`], returned when reading or writing the
/// `.desktop` file used to register a protocol scheme. Only used on Linux.
#[cfg(target_os = "linux")]
#[error(transparent)]
Ini(#[from] ini::Error),
/// Transparent wrapper around an [`ini::ParseError`], returned when parsing the
/// `.desktop` file used to register a protocol scheme. Only used on Linux.
#[cfg(target_os = "linux")]
#[error(transparent)]
ParseIni(#[from] ini::ParseError),
/// Transparent wrapper around a [`tauri::plugin::mobile::PluginInvokeError`], returned
/// when the underlying mobile plugin invocation fails. Only used on mobile.
#[cfg(mobile)]
#[error(transparent)]
PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),