webkit6/auto/

web_resource.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from webkit-gir-files
// DO NOT EDIT

use crate::{URIRequest, URIResponse, ffi};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::{boxed::Box as Box_, pin::Pin};

glib::wrapper! {
    /// Represents a resource at the end of a URI.
    ///
    /// A [`WebResource`][crate::WebResource] encapsulates content for each resource at the
    /// end of a particular URI. For example, one [`WebResource`][crate::WebResource] will
    /// be created for each separate image and stylesheet when a page is
    /// loaded.
    ///
    /// You can access the response and the URI for a given
    /// [`WebResource`][crate::WebResource], using [`uri()`][Self::uri()] and
    /// [`response()`][Self::response()], as well as the raw data, using
    /// [`data()`][Self::data()].
    ///
    /// ## Properties
    ///
    ///
    /// #### `response`
    ///  The [`URIResponse`][crate::URIResponse] associated with this resource.
    ///
    /// Readable
    ///
    ///
    /// #### `uri`
    ///  The current active URI of the [`WebResource`][crate::WebResource].
    /// See [`WebResource::uri()`][crate::WebResource::uri()] for more details.
    ///
    /// Readable
    ///
    /// ## Signals
    ///
    ///
    /// #### `failed`
    ///  This signal is emitted when an error occurs during the resource
    /// load operation.
    ///
    ///
    ///
    ///
    /// #### `failed-with-tls-errors`
    ///  This signal is emitted when a TLS error occurs during the resource load operation.
    ///
    ///
    ///
    ///
    /// #### `finished`
    ///  This signal is emitted when the resource load finishes successfully
    /// or due to an error. In case of errors [`failed`][struct@crate::WebResource#failed] signal
    /// is emitted before this one.
    ///
    ///
    ///
    ///
    /// #### `sent-request`
    ///  This signal is emitted when `request` has been sent to the
    /// server. In case of a server redirection this signal is
    /// emitted again with the `request` argument containing the new
    /// request sent to the server due to the redirection and the
    /// `redirected_response` parameter containing the response
    /// received by the server for the initial request.
    ///
    ///
    #[doc(alias = "WebKitWebResource")]
    pub struct WebResource(Object<ffi::WebKitWebResource, ffi::WebKitWebResourceClass>);

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

impl WebResource {
    /// Asynchronously get the raw data for `self`.
    ///
    /// When the operation is finished, `callback` will be called. You can then call
    /// `webkit_web_resource_get_data_finish()` to get the result of the operation.
    /// ## `cancellable`
    /// a [`gio::Cancellable`][crate::gio::Cancellable] or [`None`] to ignore
    /// ## `callback`
    /// a `GAsyncReadyCallback` to call when the request is satisfied
    #[doc(alias = "webkit_web_resource_get_data")]
    #[doc(alias = "get_data")]
    pub fn data<P: FnOnce(Result<Vec<u8>, glib::Error>) + 'static>(
        &self,
        cancellable: Option<&impl IsA<gio::Cancellable>>,
        callback: P,
    ) {
        let main_context = glib::MainContext::ref_thread_default();
        let is_main_context_owner = main_context.is_owner();
        let has_acquired_main_context = (!is_main_context_owner)
            .then(|| main_context.acquire().ok())
            .flatten();
        assert!(
            is_main_context_owner || has_acquired_main_context.is_some(),
            "Async operations only allowed if the thread is owning the MainContext"
        );

        let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
            Box_::new(glib::thread_guard::ThreadGuard::new(callback));
        unsafe extern "C" fn data_trampoline<P: FnOnce(Result<Vec<u8>, glib::Error>) + 'static>(
            _source_object: *mut glib::gobject_ffi::GObject,
            res: *mut gio::ffi::GAsyncResult,
            user_data: glib::ffi::gpointer,
        ) {
            unsafe {
                let mut error = std::ptr::null_mut();
                let mut length = std::mem::MaybeUninit::uninit();
                let ret = ffi::webkit_web_resource_get_data_finish(
                    _source_object as *mut _,
                    res,
                    length.as_mut_ptr(),
                    &mut error,
                );
                let result = if error.is_null() {
                    Ok(FromGlibContainer::from_glib_full_num(
                        ret,
                        length.assume_init() as _,
                    ))
                } else {
                    Err(from_glib_full(error))
                };
                let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
                    Box_::from_raw(user_data as *mut _);
                let callback: P = callback.into_inner();
                callback(result);
            }
        }
        let callback = data_trampoline::<P>;
        unsafe {
            ffi::webkit_web_resource_get_data(
                self.to_glib_none().0,
                cancellable.map(|p| p.as_ref()).to_glib_none().0,
                Some(callback),
                Box_::into_raw(user_data) as *mut _,
            );
        }
    }

    pub fn data_future(
        &self,
    ) -> Pin<Box_<dyn std::future::Future<Output = Result<Vec<u8>, glib::Error>> + 'static>> {
        Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
            obj.data(Some(cancellable), move |res| {
                send.resolve(res);
            });
        }))
    }

    /// Retrieves the [`URIResponse`][crate::URIResponse] of the resource load operation.
    ///
    /// This method returns [`None`] if called before the response
    /// is received from the server. You can connect to notify::response
    /// signal to be notified when the response is received.
    ///
    /// # Returns
    ///
    /// the [`URIResponse`][crate::URIResponse], or [`None`] if
    ///  the response hasn't been received yet.
    #[doc(alias = "webkit_web_resource_get_response")]
    #[doc(alias = "get_response")]
    pub fn response(&self) -> Option<URIResponse> {
        unsafe { from_glib_none(ffi::webkit_web_resource_get_response(self.to_glib_none().0)) }
    }

    /// Returns the current active URI of `self`.
    ///
    /// The active URI might change during
    /// a load operation:
    ///
    /// `<orderedlist>`
    /// `<listitem>``<para>`
    ///  When the resource load starts, the active URI is the requested URI
    /// `</para>``</listitem>`
    /// `<listitem>``<para>`
    ///  When the initial request is sent to the server, [`sent-request`][struct@crate::WebResource#sent-request]
    ///  signal is emitted without a redirected response, the active URI is the URI of
    ///  the request sent to the server.
    /// `</para>``</listitem>`
    /// `<listitem>``<para>`
    ///  In case of a server redirection, [`sent-request`][struct@crate::WebResource#sent-request] signal
    ///  is emitted again with a redirected response, the active URI is the URI the request
    ///  was redirected to.
    /// `</para>``</listitem>`
    /// `<listitem>``<para>`
    ///  When the response is received from the server, the active URI is the final
    ///  one and it will not change again.
    /// `</para>``</listitem>`
    /// `</orderedlist>`
    ///
    /// You can monitor the active URI by connecting to the notify::uri
    /// signal of `self`.
    ///
    /// # Returns
    ///
    /// the current active URI of `self`
    #[doc(alias = "webkit_web_resource_get_uri")]
    #[doc(alias = "get_uri")]
    pub fn uri(&self) -> Option<glib::GString> {
        unsafe { from_glib_none(ffi::webkit_web_resource_get_uri(self.to_glib_none().0)) }
    }

    /// This signal is emitted when an error occurs during the resource
    /// load operation.
    /// ## `error`
    /// the [`glib::Error`][crate::glib::Error] that was triggered
    #[doc(alias = "failed")]
    pub fn connect_failed<F: Fn(&Self, &glib::Error) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn failed_trampoline<F: Fn(&WebResource, &glib::Error) + 'static>(
            this: *mut ffi::WebKitWebResource,
            error: *mut glib::ffi::GError,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this), &from_glib_borrow(error))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"failed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    failed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted when a TLS error occurs during the resource load operation.
    /// ## `certificate`
    /// a [`gio::TlsCertificate`][crate::gio::TlsCertificate]
    /// ## `errors`
    /// a [`gio::TlsCertificateFlags`][crate::gio::TlsCertificateFlags] with the verification status of `certificate`
    #[doc(alias = "failed-with-tls-errors")]
    pub fn connect_failed_with_tls_errors<
        F: Fn(&Self, &gio::TlsCertificate, gio::TlsCertificateFlags) + 'static,
    >(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn failed_with_tls_errors_trampoline<
            F: Fn(&WebResource, &gio::TlsCertificate, gio::TlsCertificateFlags) + 'static,
        >(
            this: *mut ffi::WebKitWebResource,
            certificate: *mut gio::ffi::GTlsCertificate,
            errors: gio::ffi::GTlsCertificateFlags,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    &from_glib_borrow(this),
                    &from_glib_borrow(certificate),
                    from_glib(errors),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"failed-with-tls-errors".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    failed_with_tls_errors_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted when the resource load finishes successfully
    /// or due to an error. In case of errors [`failed`][struct@crate::WebResource#failed] signal
    /// is emitted before this one.
    #[doc(alias = "finished")]
    pub fn connect_finished<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn finished_trampoline<F: Fn(&WebResource) + 'static>(
            this: *mut ffi::WebKitWebResource,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"finished".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    finished_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted when `request` has been sent to the
    /// server. In case of a server redirection this signal is
    /// emitted again with the `request` argument containing the new
    /// request sent to the server due to the redirection and the
    /// `redirected_response` parameter containing the response
    /// received by the server for the initial request.
    /// ## `request`
    /// a [`URIRequest`][crate::URIRequest]
    /// ## `redirected_response`
    /// a [`URIResponse`][crate::URIResponse], or [`None`]
    #[doc(alias = "sent-request")]
    pub fn connect_sent_request<F: Fn(&Self, &URIRequest, &URIResponse) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn sent_request_trampoline<
            F: Fn(&WebResource, &URIRequest, &URIResponse) + 'static,
        >(
            this: *mut ffi::WebKitWebResource,
            request: *mut ffi::WebKitURIRequest,
            redirected_response: *mut ffi::WebKitURIResponse,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    &from_glib_borrow(this),
                    &from_glib_borrow(request),
                    &from_glib_borrow(redirected_response),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"sent-request".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    sent_request_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "response")]
    pub fn connect_response_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_response_trampoline<F: Fn(&WebResource) + 'static>(
            this: *mut ffi::WebKitWebResource,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::response".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_response_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "uri")]
    pub fn connect_uri_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_uri_trampoline<F: Fn(&WebResource) + 'static>(
            this: *mut ffi::WebKitWebResource,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::uri".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_uri_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}