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
71
72
73
74
75
76
77

use serde::{Deserialize, Serialize};

/// Defines the path and required permissions for a specific subset of data
/// within a content provider.
///
/// This element can be specified multiple times to
/// supply multiple paths.
///
/// ## XML Syntax
/// ```xml
/// <path-permission android:path="string"
///                  android:pathPrefix="string"
///                  android:pathPattern="string"
///                  android:permission="string"
///                  android:readPermission="string"
///                  android:writePermission="string" />
/// ```
///
/// ## Contained in
/// * [`<provider>`]
///
/// ## Introduced in
/// API Level 4
///
/// [`<provider>`]: crate::Provider
#[derive(
    Debug, Deserialize, Serialize, YaSerialize, YaDeserialize, PartialEq, Eq, Default, Clone,
)]
pub struct PathPermission {
    /// A complete URI path for a subset of content provider data. Permission can be
    /// granted only to the particular data identified by this path. When used to
    /// provide search suggestion content, it must be appended with
    /// "/search_suggest_query".
    #[yaserde(attribute, prefix = "android")]
    pub path: Option<String>,
    /// The initial part of a URI path for a subset of content provider data. Permission
    /// can be granted to all data subsets with paths that share this initial part.
    #[yaserde(attribute, prefix = "android", rename = "pathPrefix")]
    pub path_prefix: Option<String>,
    /// A complete URI path for a subset of content provider data, but one that
    /// can use the following wildcards:
    ///
    /// * An asterisk `('*')`. This matches a sequence of 0 to many occurrences of the
    ///   immediately precedingcharacter.
    /// * A period followed by an asterisk `(".*")`. This matches any
    /// sequence of 0 or more characters.
    ///
    /// Because `'\'` is used as an escape character when the string is read from XML
    /// (before it is parsed as a pattern), you will need to double-escape. For
    /// example, a literal `'*'` would be written as `"\\*"` and a literal `'\'` would be
    /// written as `"\\"`. This is basically the same as what you would need to write if
    /// constructing the string in Java code.
    ///
    /// For more information on these types of patterns, see the descriptions of
    /// [`PATTERN_LITERAL`], [`PATTERN_PREFIX`], and [`PATTERN_SIMPLE_GLOB`] in the
    /// [`PatternMatcher`] class.
    ///
    /// [`PATTERN_LITERAL`]: https://developer.android.com/reference/android/os/PatternMatcher#PATTERN_LITERAL
    /// [`PATTERN_PREFIX`]: https://developer.android.com/reference/android/os/PatternMatcher#PATTERN_PREFIX
    /// [`PATTERN_SIMPLE_GLOB`]: https://developer.android.com/reference/android/os/PatternMatcher#PATTERN_SIMPLE_GLOB
    /// [`PatternMatcher`]: https://developer.android.com/reference/android/os/PatternMatcher
    #[yaserde(attribute, prefix = "android", rename = "pathPattern")]
    pub path_pattern: Option<String>,
    /// The name of a permission that clients must have in order to read or write the
    /// content provider's data. This attribute is a convenient way of setting a
    /// single permission for both reading and writing. However, the `readPermission`
    /// and `writePermission` attributes take precedence over this one.
    #[yaserde(attribute, prefix = "android")]
    pub permission: Option<String>,
    /// A permission that clients must have in order to query the content provider.
    #[yaserde(attribute, prefix = "android", rename = "readPermission")]
    pub read_permission: Option<String>,
    /// A permission that clients must have in order to make changes to the data
    /// controlled by the content provider.
    #[yaserde(attribute, prefix = "android", rename = "writePermission")]
    pub write_permission: Option<String>,
}