capacitor_bindings 0.14.0

Capacitor bindings to help you build android and ios apps with 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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;
use typed_builder::TypedBuilder;

use crate::{
    extern_functions::{read, write},
    helpers::*,
};

use crate::error::Error;

pub struct Clipboard;

impl Clipboard {
    /// Show an alert dialog
    pub async fn write(options: impl Into<WriteOptions>) -> Result<(), Error> {
        run_value_unit(options, write).await
    }

    /// Show a prompt dialog
    pub async fn read() -> Result<ReadResult, Error> {
        run_unit_value(read).await
    }
}

/// Represents the data to be written to the clipboard.
#[skip_serializing_none]
#[derive(Clone, Default, Debug, PartialEq, Eq, Serialize, Deserialize, TypedBuilder)]
#[serde(rename_all = "camelCase", default)]
pub struct WriteOptions {
    #[builder(default, setter(strip_option, into))]
    /// Text value to copy.
    pub string: Option<String>,

    #[builder(default, setter(strip_option, into))]
    /// Image in Data URL format to copy.
    pub image: Option<String>,

    #[builder(default, setter(strip_option, into))]
    /// URL string to copy.
    pub url: Option<String>,

    #[builder(default, setter(strip_option, into))]
    /// User visible label to accompany the copied data (Android Only).
    pub label: Option<String>,
}

/// Represents the data read from the clipboard.
#[skip_serializing_none]
#[derive(Clone, Default, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", default)]
pub struct ReadResult {
    /// Data read from the clipboard.
    pub value: String,
    /// Type of data in the clipboard.
    pub r#type: String,
}