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

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{ffi, URIType};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// The [`URIHandler`][crate::URIHandler] is an interface that is implemented by Source and Sink
    /// [`Element`][crate::Element] to unify handling of URI.
    ///
    /// An application can use the following functions to quickly get an element
    /// that handles the given URI for reading or writing
    /// ([`Element::make_from_uri()`][crate::Element::make_from_uri()]).
    ///
    /// Source and Sink plugins should implement this interface when possible.
    ///
    /// # Implements
    ///
    /// [`URIHandlerExt`][trait@crate::prelude::URIHandlerExt]
    #[doc(alias = "GstURIHandler")]
    pub struct URIHandler(Interface<ffi::GstURIHandler, ffi::GstURIHandlerInterface>);

    match fn {
        type_ => || ffi::gst_uri_handler_get_type(),
    }
}

impl URIHandler {
    pub const NONE: Option<&'static URIHandler> = None;
}

unsafe impl Send for URIHandler {}
unsafe impl Sync for URIHandler {}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::URIHandler>> Sealed for T {}
}

/// Trait containing all [`struct@URIHandler`] methods.
///
/// # Implementors
///
/// [`URIHandler`][struct@crate::URIHandler]
pub trait URIHandlerExt: IsA<URIHandler> + sealed::Sealed + 'static {
    /// Gets the list of protocols supported by `self`. This list may not be
    /// modified.
    ///
    /// # Returns
    ///
    /// the
    ///  supported protocols. Returns [`None`] if the `self` isn't
    ///  implemented properly, or the `self` doesn't support any
    ///  protocols.
    #[doc(alias = "gst_uri_handler_get_protocols")]
    #[doc(alias = "get_protocols")]
    fn protocols(&self) -> Vec<glib::GString> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::gst_uri_handler_get_protocols(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the currently handled URI.
    ///
    /// # Returns
    ///
    /// the URI currently handled by
    ///  the `self`. Returns [`None`] if there are no URI currently
    ///  handled. The returned string must be freed with `g_free()` when no
    ///  longer needed.
    #[doc(alias = "gst_uri_handler_get_uri")]
    #[doc(alias = "get_uri")]
    fn uri(&self) -> Option<glib::GString> {
        unsafe { from_glib_full(ffi::gst_uri_handler_get_uri(self.as_ref().to_glib_none().0)) }
    }

    /// Gets the type of the given URI handler
    ///
    /// # Returns
    ///
    /// the [`URIType`][crate::URIType] of the URI handler.
    /// Returns [`URIType::Unknown`][crate::URIType::Unknown] if the `self` isn't implemented correctly.
    #[doc(alias = "gst_uri_handler_get_uri_type")]
    #[doc(alias = "get_uri_type")]
    fn uri_type(&self) -> URIType {
        unsafe {
            from_glib(ffi::gst_uri_handler_get_uri_type(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Tries to set the URI of the given handler.
    /// ## `uri`
    /// URI to set
    ///
    /// # Returns
    ///
    /// [`true`] if the URI was set successfully, else [`false`].
    #[doc(alias = "gst_uri_handler_set_uri")]
    fn set_uri(&self, uri: &str) -> Result<(), glib::Error> {
        unsafe {
            let mut error = std::ptr::null_mut();
            let is_ok = ffi::gst_uri_handler_set_uri(
                self.as_ref().to_glib_none().0,
                uri.to_glib_none().0,
                &mut error,
            );
            debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
            if error.is_null() {
                Ok(())
            } else {
                Err(from_glib_full(error))
            }
        }
    }
}

impl<O: IsA<URIHandler>> URIHandlerExt for O {}