objc2_core_services/generated/SearchKit/
SKSummary.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::cell::UnsafeCell;
4use core::marker::{PhantomData, PhantomPinned};
5use core::ptr::NonNull;
6#[cfg(feature = "objc2")]
7use objc2::__framework_prelude::*;
8use objc2_core_foundation::*;
9
10use crate::*;
11
12/// [Apple's documentation](https://developer.apple.com/documentation/coreservices/sksummary?language=objc)
13#[doc(alias = "SKSummaryRef")]
14#[repr(C)]
15pub struct SKSummary {
16    inner: [u8; 0],
17    _p: UnsafeCell<PhantomData<(*const UnsafeCell<()>, PhantomPinned)>>,
18}
19
20cf_type!(
21    unsafe impl SKSummary {}
22);
23#[cfg(feature = "objc2")]
24cf_objc2_type!(
25    unsafe impl RefEncode<"__SKSummary"> for SKSummary {}
26);
27
28unsafe impl ConcreteType for SKSummary {
29    #[doc(alias = "SKSummaryGetTypeID")]
30    #[inline]
31    fn type_id() -> CFTypeID {
32        extern "C-unwind" {
33            fn SKSummaryGetTypeID() -> CFTypeID;
34        }
35        unsafe { SKSummaryGetTypeID() }
36    }
37}
38
39impl SKSummary {
40    /// # Safety
41    ///
42    /// `in_string` might not allow `None`.
43    #[doc(alias = "SKSummaryCreateWithString")]
44    #[inline]
45    pub unsafe fn with_string(in_string: Option<&CFString>) -> Option<CFRetained<SKSummary>> {
46        extern "C-unwind" {
47            fn SKSummaryCreateWithString(
48                in_string: Option<&CFString>,
49            ) -> Option<NonNull<SKSummary>>;
50        }
51        let ret = unsafe { SKSummaryCreateWithString(in_string) };
52        ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
53    }
54
55    #[doc(alias = "SKSummaryGetSentenceCount")]
56    #[inline]
57    pub unsafe fn sentence_count(&self) -> CFIndex {
58        extern "C-unwind" {
59            fn SKSummaryGetSentenceCount(summary: &SKSummary) -> CFIndex;
60        }
61        unsafe { SKSummaryGetSentenceCount(self) }
62    }
63
64    #[doc(alias = "SKSummaryGetParagraphCount")]
65    #[inline]
66    pub unsafe fn paragraph_count(&self) -> CFIndex {
67        extern "C-unwind" {
68            fn SKSummaryGetParagraphCount(summary: &SKSummary) -> CFIndex;
69        }
70        unsafe { SKSummaryGetParagraphCount(self) }
71    }
72
73    #[doc(alias = "SKSummaryCopySentenceAtIndex")]
74    #[inline]
75    pub unsafe fn sentence_at_index(&self, i: CFIndex) -> Option<CFRetained<CFString>> {
76        extern "C-unwind" {
77            fn SKSummaryCopySentenceAtIndex(
78                summary: &SKSummary,
79                i: CFIndex,
80            ) -> Option<NonNull<CFString>>;
81        }
82        let ret = unsafe { SKSummaryCopySentenceAtIndex(self, i) };
83        ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
84    }
85
86    #[doc(alias = "SKSummaryCopyParagraphAtIndex")]
87    #[inline]
88    pub unsafe fn paragraph_at_index(&self, i: CFIndex) -> Option<CFRetained<CFString>> {
89        extern "C-unwind" {
90            fn SKSummaryCopyParagraphAtIndex(
91                summary: &SKSummary,
92                i: CFIndex,
93            ) -> Option<NonNull<CFString>>;
94        }
95        let ret = unsafe { SKSummaryCopyParagraphAtIndex(self, i) };
96        ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
97    }
98
99    #[doc(alias = "SKSummaryCopySentenceSummaryString")]
100    #[inline]
101    pub unsafe fn sentence_summary_string(
102        &self,
103        num_sentences: CFIndex,
104    ) -> Option<CFRetained<CFString>> {
105        extern "C-unwind" {
106            fn SKSummaryCopySentenceSummaryString(
107                summary: &SKSummary,
108                num_sentences: CFIndex,
109            ) -> Option<NonNull<CFString>>;
110        }
111        let ret = unsafe { SKSummaryCopySentenceSummaryString(self, num_sentences) };
112        ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
113    }
114
115    #[doc(alias = "SKSummaryCopyParagraphSummaryString")]
116    #[inline]
117    pub unsafe fn paragraph_summary_string(
118        &self,
119        num_paragraphs: CFIndex,
120    ) -> Option<CFRetained<CFString>> {
121        extern "C-unwind" {
122            fn SKSummaryCopyParagraphSummaryString(
123                summary: &SKSummary,
124                num_paragraphs: CFIndex,
125            ) -> Option<NonNull<CFString>>;
126        }
127        let ret = unsafe { SKSummaryCopyParagraphSummaryString(self, num_paragraphs) };
128        ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
129    }
130
131    /// # Safety
132    ///
133    /// - `out_rank_order_of_sentences` must be a valid pointer.
134    /// - `out_sentence_index_of_sentences` must be a valid pointer.
135    /// - `out_paragraph_index_of_sentences` must be a valid pointer.
136    #[doc(alias = "SKSummaryGetSentenceSummaryInfo")]
137    #[inline]
138    pub unsafe fn sentence_summary_info(
139        &self,
140        num_sentences_in_summary: CFIndex,
141        out_rank_order_of_sentences: *mut CFIndex,
142        out_sentence_index_of_sentences: *mut CFIndex,
143        out_paragraph_index_of_sentences: *mut CFIndex,
144    ) -> CFIndex {
145        extern "C-unwind" {
146            fn SKSummaryGetSentenceSummaryInfo(
147                summary: &SKSummary,
148                num_sentences_in_summary: CFIndex,
149                out_rank_order_of_sentences: *mut CFIndex,
150                out_sentence_index_of_sentences: *mut CFIndex,
151                out_paragraph_index_of_sentences: *mut CFIndex,
152            ) -> CFIndex;
153        }
154        unsafe {
155            SKSummaryGetSentenceSummaryInfo(
156                self,
157                num_sentences_in_summary,
158                out_rank_order_of_sentences,
159                out_sentence_index_of_sentences,
160                out_paragraph_index_of_sentences,
161            )
162        }
163    }
164
165    /// # Safety
166    ///
167    /// - `out_rank_order_of_paragraphs` must be a valid pointer.
168    /// - `out_paragraph_index_of_paragraphs` must be a valid pointer.
169    #[doc(alias = "SKSummaryGetParagraphSummaryInfo")]
170    #[inline]
171    pub unsafe fn paragraph_summary_info(
172        &self,
173        num_paragraphs_in_summary: CFIndex,
174        out_rank_order_of_paragraphs: *mut CFIndex,
175        out_paragraph_index_of_paragraphs: *mut CFIndex,
176    ) -> CFIndex {
177        extern "C-unwind" {
178            fn SKSummaryGetParagraphSummaryInfo(
179                summary: &SKSummary,
180                num_paragraphs_in_summary: CFIndex,
181                out_rank_order_of_paragraphs: *mut CFIndex,
182                out_paragraph_index_of_paragraphs: *mut CFIndex,
183            ) -> CFIndex;
184        }
185        unsafe {
186            SKSummaryGetParagraphSummaryInfo(
187                self,
188                num_paragraphs_in_summary,
189                out_rank_order_of_paragraphs,
190                out_paragraph_index_of_paragraphs,
191            )
192        }
193    }
194}
195
196#[deprecated = "renamed to `SKSummary::with_string`"]
197#[inline]
198pub unsafe extern "C-unwind" fn SKSummaryCreateWithString(
199    in_string: Option<&CFString>,
200) -> Option<CFRetained<SKSummary>> {
201    extern "C-unwind" {
202        fn SKSummaryCreateWithString(in_string: Option<&CFString>) -> Option<NonNull<SKSummary>>;
203    }
204    let ret = unsafe { SKSummaryCreateWithString(in_string) };
205    ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
206}
207
208extern "C-unwind" {
209    #[deprecated = "renamed to `SKSummary::sentence_count`"]
210    pub fn SKSummaryGetSentenceCount(summary: &SKSummary) -> CFIndex;
211}
212
213extern "C-unwind" {
214    #[deprecated = "renamed to `SKSummary::paragraph_count`"]
215    pub fn SKSummaryGetParagraphCount(summary: &SKSummary) -> CFIndex;
216}
217
218#[deprecated = "renamed to `SKSummary::sentence_at_index`"]
219#[inline]
220pub unsafe extern "C-unwind" fn SKSummaryCopySentenceAtIndex(
221    summary: &SKSummary,
222    i: CFIndex,
223) -> Option<CFRetained<CFString>> {
224    extern "C-unwind" {
225        fn SKSummaryCopySentenceAtIndex(
226            summary: &SKSummary,
227            i: CFIndex,
228        ) -> Option<NonNull<CFString>>;
229    }
230    let ret = unsafe { SKSummaryCopySentenceAtIndex(summary, i) };
231    ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
232}
233
234#[deprecated = "renamed to `SKSummary::paragraph_at_index`"]
235#[inline]
236pub unsafe extern "C-unwind" fn SKSummaryCopyParagraphAtIndex(
237    summary: &SKSummary,
238    i: CFIndex,
239) -> Option<CFRetained<CFString>> {
240    extern "C-unwind" {
241        fn SKSummaryCopyParagraphAtIndex(
242            summary: &SKSummary,
243            i: CFIndex,
244        ) -> Option<NonNull<CFString>>;
245    }
246    let ret = unsafe { SKSummaryCopyParagraphAtIndex(summary, i) };
247    ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
248}
249
250#[deprecated = "renamed to `SKSummary::sentence_summary_string`"]
251#[inline]
252pub unsafe extern "C-unwind" fn SKSummaryCopySentenceSummaryString(
253    summary: &SKSummary,
254    num_sentences: CFIndex,
255) -> Option<CFRetained<CFString>> {
256    extern "C-unwind" {
257        fn SKSummaryCopySentenceSummaryString(
258            summary: &SKSummary,
259            num_sentences: CFIndex,
260        ) -> Option<NonNull<CFString>>;
261    }
262    let ret = unsafe { SKSummaryCopySentenceSummaryString(summary, num_sentences) };
263    ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
264}
265
266#[deprecated = "renamed to `SKSummary::paragraph_summary_string`"]
267#[inline]
268pub unsafe extern "C-unwind" fn SKSummaryCopyParagraphSummaryString(
269    summary: &SKSummary,
270    num_paragraphs: CFIndex,
271) -> Option<CFRetained<CFString>> {
272    extern "C-unwind" {
273        fn SKSummaryCopyParagraphSummaryString(
274            summary: &SKSummary,
275            num_paragraphs: CFIndex,
276        ) -> Option<NonNull<CFString>>;
277    }
278    let ret = unsafe { SKSummaryCopyParagraphSummaryString(summary, num_paragraphs) };
279    ret.map(|ret| unsafe { CFRetained::from_raw(ret) })
280}
281
282extern "C-unwind" {
283    #[deprecated = "renamed to `SKSummary::sentence_summary_info`"]
284    pub fn SKSummaryGetSentenceSummaryInfo(
285        summary: &SKSummary,
286        num_sentences_in_summary: CFIndex,
287        out_rank_order_of_sentences: *mut CFIndex,
288        out_sentence_index_of_sentences: *mut CFIndex,
289        out_paragraph_index_of_sentences: *mut CFIndex,
290    ) -> CFIndex;
291}
292
293extern "C-unwind" {
294    #[deprecated = "renamed to `SKSummary::paragraph_summary_info`"]
295    pub fn SKSummaryGetParagraphSummaryInfo(
296        summary: &SKSummary,
297        num_paragraphs_in_summary: CFIndex,
298        out_rank_order_of_paragraphs: *mut CFIndex,
299        out_paragraph_index_of_paragraphs: *mut CFIndex,
300    ) -> CFIndex;
301}
objc2_core_services/generated/SearchKit/SKSummary.rs

objc2_core_services/generated/SearchKit/
SKSummary.rs
