gstreamer/
plugin_feature.rs

Help
1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use glib::{
4    prelude::*,
5    translate::{from_glib, FromGlibPtrFull, IntoGlib, ToGlibPtr},
6};
7
8use crate::{ffi, PluginFeature, Rank};
9
10mod sealed {
11    pub trait Sealed {}
12    impl<T: super::IsA<super::PluginFeature>> Sealed for T {}
13}
14
15pub trait PluginFeatureExtManual: sealed::Sealed + IsA<PluginFeature> + Sized + 'static {
16    /// Gets the rank of a plugin feature.
17    ///
18    /// # Returns
19    ///
20    /// The rank of the feature
21    #[doc(alias = "get_rank")]
22    #[doc(alias = "gst_plugin_feature_get_rank")]
23    fn rank(&self) -> Rank {
24        unsafe {
25            let rank = ffi::gst_plugin_feature_get_rank(self.as_ref().to_glib_none().0);
26            from_glib(rank as i32)
27        }
28    }
29
30    /// Specifies a rank for a plugin feature, so that autoplugging uses
31    /// the most appropriate feature.
32    /// ## `rank`
33    /// rank value - higher number means more priority rank
34    #[doc(alias = "gst_plugin_feature_set_rank")]
35    fn set_rank(&self, rank: Rank) {
36        unsafe {
37            ffi::gst_plugin_feature_set_rank(
38                self.as_ref().to_glib_none().0,
39                rank.into_glib() as u32,
40            );
41        }
42    }
43
44    /// Loads the plugin containing `self` if it's not already loaded. `self` is
45    /// unaffected; use the return value instead.
46    ///
47    /// Normally this function is used like this:
48    ///
49    ///
50    /// **⚠️ The following code is in C ⚠️**
51    ///
52    /// ```C
53    /// GstPluginFeature *loaded_feature;
54    ///
55    /// loaded_feature = gst_plugin_feature_load (feature);
56    /// // presumably, we're no longer interested in the potentially-unloaded feature
57    /// gst_object_unref (feature);
58    /// feature = loaded_feature;
59    /// ```
60    ///
61    /// # Returns
62    ///
63    /// a reference to the loaded
64    /// feature, or [`None`] on error
65    #[doc(alias = "gst_plugin_feature_load")]
66    fn load(&self) -> Result<Self, glib::BoolError> {
67        unsafe {
68            let loaded = Option::<PluginFeature>::from_glib_full(ffi::gst_plugin_feature_load(
69                self.as_ref().to_glib_none().0,
70            ))
71            .ok_or_else(|| glib::bool_error!("Failed to load plugin feature"))?;
72            Ok(loaded.unsafe_cast())
73        }
74    }
75}
76
77impl<O: IsA<PluginFeature>> PluginFeatureExtManual for O {}
78
79#[cfg(test)]
80mod tests {
81    use super::*;
82
83    #[test]
84    fn test_load() {
85        crate::init().unwrap();
86
87        let factory = crate::ElementFactory::find("identity").unwrap();
88        let loaded = factory.load().unwrap();
89        assert_eq!(factory.type_(), loaded.type_());
90        let _element = loaded.create().build().unwrap();
91    }
92}
gstreamer/plugin_feature.rs

gstreamer/
plugin_feature.rs
