gio/
io_extension.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use std::{fmt, marker::PhantomData, ptr};
4
5use crate::ffi;
6use glib::{Type, translate::*};
7
8// rustdoc-stripper-ignore-next
9/// The implementation of an `IOExtensionPoint`.
10// rustdoc-stripper-ignore-next-stop
11/// #GIOExtension is an opaque data structure and can only be accessed
12/// using the following functions.
13#[doc(alias = "GIOExtension")]
14#[derive(Copy, Clone, Eq, PartialEq)]
15pub struct IOExtension(ptr::NonNull<ffi::GIOExtension>);
16
17impl fmt::Debug for IOExtension {
18    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
19        f.debug_struct("IOExtension")
20            .field("name", &self.name())
21            .field("priority", &self.priority())
22            .field("type", &self.type_())
23            .finish()
24    }
25}
26
27impl FromGlibPtrNone<*mut ffi::GIOExtension> for IOExtension {
28    #[inline]
29    unsafe fn from_glib_none(ptr: *mut ffi::GIOExtension) -> Self {
30        unsafe {
31            debug_assert!(!ptr.is_null());
32            IOExtension(ptr::NonNull::new_unchecked(ptr))
33        }
34    }
35}
36
37impl<'a> ToGlibPtr<'a, *mut ffi::GIOExtension> for &'a IOExtension {
38    type Storage = PhantomData<&'a IOExtension>;
39
40    #[inline]
41    fn to_glib_none(&self) -> Stash<'a, *mut ffi::GIOExtension, &'a IOExtension> {
42        Stash(self.0.as_ptr() as *mut ffi::GIOExtension, PhantomData)
43    }
44}
45
46impl IOExtension {
47    /// Gets the name under which @self was registered.
48    ///
49    /// Note that the same type may be registered as extension
50    /// for multiple extension points, under different names.
51    ///
52    /// # Returns
53    ///
54    /// the name of @self.
55    #[doc(alias = "g_io_extension_get_name")]
56    pub fn name(&self) -> glib::GString {
57        unsafe { from_glib_none(ffi::g_io_extension_get_name(self.0.as_ptr())) }
58    }
59
60    /// Gets the priority with which @self was registered.
61    ///
62    /// # Returns
63    ///
64    /// the priority of @self
65    #[doc(alias = "g_io_extension_get_priority")]
66    pub fn priority(&self) -> i32 {
67        unsafe { ffi::g_io_extension_get_priority(self.0.as_ptr()) }
68    }
69
70    /// Gets the type associated with @self.
71    ///
72    /// # Returns
73    ///
74    /// the type of @self
75    #[doc(alias = "g_io_extension_get_type")]
76    pub fn type_(&self) -> Type {
77        unsafe { from_glib(ffi::g_io_extension_get_type(self.0.as_ptr())) }
78    }
79}
gio/io_extension.rs

gio/
io_extension.rs
