1use crate::{ffi, PyAny, PyDowncastError, PyTryFrom, Python};
2
3/// Represents the Python `Ellipsis` object.
4#[repr(transparent)]
5pub struct PyEllipsis(PyAny);
6
7pyobject_native_type_named!(PyEllipsis);
8pyobject_native_type_extract!(PyEllipsis);
9
10impl PyEllipsis {
11 /// Returns the `Ellipsis` object.
12 #[inline]
13 pub fn get(py: Python<'_>) -> &PyEllipsis {
14 unsafe { py.from_borrowed_ptr(ffi::Py_Ellipsis()) }
15 }
16}
17
18impl<'v> PyTryFrom<'v> for PyEllipsis {
19 fn try_from<V: Into<&'v PyAny>>(value: V) -> Result<&'v Self, crate::PyDowncastError<'v>> {
20 let value: &PyAny = value.into();
21 if unsafe { ffi::Py_Ellipsis() == value.as_ptr() } {
22 return unsafe { Ok(value.downcast_unchecked()) };
23 }
24 Err(PyDowncastError::new(from:value, to:"ellipsis"))
25 }
26
27 fn try_from_exact<V: Into<&'v PyAny>>(
28 value: V,
29 ) -> Result<&'v Self, crate::PyDowncastError<'v>> {
30 value.into().downcast()
31 }
32
33 unsafe fn try_from_unchecked<V: Into<&'v PyAny>>(value: V) -> &'v Self {
34 let ptr: *const PyEllipsis = value.into() as *const _ as *const PyEllipsis;
35 &*ptr
36 }
37}
38
39#[cfg(test)]
40mod tests {
41 use crate::types::{PyDict, PyEllipsis};
42 use crate::Python;
43
44 #[test]
45 fn test_ellipsis_is_itself() {
46 Python::with_gil(|py| {
47 assert!(PyEllipsis::get(py)
48 .downcast::<PyEllipsis>()
49 .unwrap()
50 .is_ellipsis());
51 })
52 }
53
54 #[test]
55 fn test_dict_is_not_ellipsis() {
56 Python::with_gil(|py| {
57 assert!(PyDict::new(py).downcast::<PyEllipsis>().is_err());
58 })
59 }
60}
61