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
58
59
60
61
62
63
64
65
66
67
68
69
70

use crate::extern_functions::*;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;
use crate::helpers::*;
use crate::{error::Error};

pub struct ScreenReader;

impl ScreenReader {
    #[cfg(any(feature = "ios", feature = "android"))]
    /// Whether a Screen Reader is currently active.
    /// This method is not supported on web (it is not possible to detect Screen Readers).
    pub async fn is_enabled() -> Result<ScreenReaderState, Error> {
        run_unit_value(screen_reader_is_enabled).await
    }

    /// Text-to-Speech functionality.
    /// This function will only work if a Screen Reader is currently active.
    /// On web, browsers must support the SpeechSynthesis API, or this method will throw an error.
    /// For more text-to-speech capabilities, please see the Capacitor Community Text-to-Speech plugin.
    pub async fn speak(options: impl Into<SpeakOptions>) -> Result<(), Error> {
        run_value_unit(options, screen_reader_speak).await
    }

    #[cfg(any(feature = "ios", feature = "android"))]
    /// Add a listener for when the screen reader is turned on or off.
    /// This event used to be named 'accessibilityScreenReaderStateChange'.
    /// This method is not supported on web (it is not possible to detect Screen Readers).
    pub async fn add_state_change_listener<F: Fn(ScreenReaderState) + 'static>(
        func: F,
    ) -> Result<crate::plugin_listener_handle::PluginListenerHandle, Error> {
        listen_async(func, "stateChange", network_add_listener).await
    }
}

#[skip_serializing_none]
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", default)]
pub struct SpeakOptions {
    /// The text to speak.
    pub value: String,
    /// The language to speak the text in, as its ISO 639-1 Code (e.g.: "en"). This option is only supported on Android.
    pub language: Option<String>,
}

#[skip_serializing_none]
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", default)]
pub struct ScreenReaderState {
    /// Whether a Screen Reader is currently active.
    pub value: bool,
}

impl From<&str> for SpeakOptions {
    fn from(value: &str) -> Self {
        SpeakOptions {
            value: value.to_string(),
            language: None,
        }
    }
}

impl From<String> for SpeakOptions {
    fn from(value: String) -> Self {
        SpeakOptions {
            value,
            language: None,
        }
    }
}