rust-macios 0.4.2

Apple Frameworks for 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use objc::{msg_send, sel, sel_impl};
use rust_macios_objective_c_runtime_proc_macros::interface_impl;

use crate::{
    foundation::{INSFormatter, NSAttributedString, NSDictionary, NSString},
    object,
    objective_c_runtime::id,
    utils::to_optional,
};

use super::CNContact;

#[repr(i64)]
pub enum CNContactFormatterStyle {
    /// Combine the contact name components into a displayable full name.
    FullName,
    /// Combine the contact phonetic name components into a displayable phonetic full name.
    PhoneticFullName,
}

#[repr(i64)]
pub enum CNContactDisplayNameOrder {
    CNContactDisplayNameOrderUserDefault,
    CNContactDisplayNameOrderGivenNameFirst,
    CNContactDisplayNameOrderFamilyNameFirst,
}

object! {
    /// An object that you use to format contact information before displaying it to the user.
    unsafe pub struct CNContactFormatter;
}

impl INSFormatter for CNContactFormatter {}

#[interface_impl(NSFormatter)]
impl CNContactFormatter {
    /* Creating a Formatted Attributed String
     */

    /// Formats the contact name as an attributed string.
    #[method]
    pub fn attributed_string_from_contact_default_attributes<K, V>(
        &self,
        contact: CNContact,
        attributes: NSDictionary<K, V>,
    ) -> Option<NSAttributedString> {
        unsafe {
            to_optional(
                msg_send![self.m_self(), attributedStringFromContact: contact defaultAttributes: attributes],
            )
        }
    }

    /// Formats the contact name as an attributed string.
    #[method]
    pub fn attributed_string_from_contact_style_default_attributes<K, V>(
        contact: CNContact,
        style: CNContactFormatterStyle,
        attributes: NSDictionary<K, V>,
    ) -> Option<NSAttributedString> {
        unsafe {
            to_optional(
                msg_send![Self::m_class(), attributedStringFromContact: contact style: style defaultAttributes: attributes],
            )
        }
    }

    /// Formats the contact name.
    #[method]
    pub fn string_from_contact(&self, contact: CNContact) -> Option<NSString> {
        unsafe { to_optional(msg_send![self.m_self(), stringFromContact: contact]) }
    }

    /// Returns the contact name, formatted with the specified formatter.
    #[method]
    pub fn string_from_contact_style(
        contact: CNContact,
        style: CNContactFormatterStyle,
    ) -> Option<NSString> {
        unsafe { to_optional(msg_send![Self::m_class(), stringFromContact: contact style: style]) }
    }

    /* Specifying the Formatting Style
     */

    /// The formatting style for the contact name.
    #[property]
    pub fn style(&self) -> CNContactFormatterStyle {
        unsafe { msg_send![self.m_self(), style] }
    }

    /// Sets the formatting style for the contact name.
    #[property]
    pub fn set_style(&mut self) -> CNContactFormatterStyle {
        unsafe { msg_send![self.m_self(), style] }
    }

    /* Getting a Descriptor
     */

    /// Returns the required key descriptor for the specified formatting style of the contact.
    #[method]
    pub fn descriptor_for_required_keys_for_style(style: CNContactFormatterStyle) -> id {
        unsafe { msg_send![Self::m_class(), descriptorForRequiredKeysForStyle: style] }
    }

    /* Getting Format Information
     */

    /// Returns the delimiter to use between name components.
    #[method]
    pub fn delimiter_for_contact(contact: CNContact) -> NSString {
        unsafe { msg_send![Self::m_class(), delimiterForContact: contact] }
    }

    /// Returns the display name order.
    #[method]
    pub fn name_order_for_contact(contact: CNContact) -> CNContactDisplayNameOrder {
        unsafe { msg_send![Self::m_class(), nameOrderForContact: contact] }
    }

    /* Type Properties
     */

    #[property]
    pub fn descriptor_for_required_keys_for_delimiter() -> id {
        unsafe { msg_send![Self::m_class(), descriptorForRequiredKeysForDelimiter] }
    }

    #[property]
    pub fn descriptor_for_required_keys_for_name_order() -> id {
        unsafe { msg_send![Self::m_class(), descriptorForRequiredKeysForNameOrder] }
    }
}