egui 0.37.0

An easy-to-use immediate mode GUI that runs on both web and native
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use alloc::sync::Arc;
use std::path::Path;

#[cfg(target_arch = "wasm32")]
use core::{future::Future, pin::Pin};

/// A file dropped into egui.
///
/// The integration owns the concrete file handle, letting egui remain independent of windowing
/// backends and file APIs.
pub trait DroppedFile: core::fmt::Debug {
    /// The path of the dropped file.
    ///
    /// This is an absolute path on native platforms. On the web, it is a relative path containing
    /// only the file name because browsers do not expose the file's local path.
    fn path(&self) -> &Path;

    /// Read the file contents.
    ///
    /// This is asynchronous because browsers can only read files asynchronously.
    ///
    /// # Errors
    ///
    /// Returns an error if the browser cannot read the file.
    #[cfg(target_arch = "wasm32")]
    fn bytes_async(&self) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, String>> + '_>>;

    /// Read the file contents.
    ///
    /// # Errors
    ///
    /// Returns an error if the file cannot be read.
    #[cfg(not(target_arch = "wasm32"))]
    fn bytes(&self) -> Result<Vec<u8>, String>;

    /// The browser file handle, if this file was dropped on the web.
    ///
    /// Requires the `web_file` feature.
    #[cfg(all(target_arch = "wasm32", feature = "web_file"))]
    fn web_file(&self) -> Option<&web_sys::File> {
        None
    }
}

/// A shared reference to a dropped file.
///
/// With wasm threads, a `web_sys::File` isn't `Send + Sync`,
/// so an integration has to wrap it, for instance with `send_wrapper::SendWrapper`.
pub type DroppedFileHandle = Arc<dyn DroppedFile + Send + Sync>;