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

use glib::translate::*;

glib::wrapper! {
    /// Contains metrics collected while loading a [`Message`][crate::Message] either from the
    /// network or the disk cache.
    ///
    /// Metrics are not collected by default for a [`Message`][crate::Message], you need to add the
    /// flag [`MessageFlags::COLLECT_METRICS`][crate::MessageFlags::COLLECT_METRICS] to enable the feature.
    ///
    /// Temporal metrics are expressed as a monotonic time and always start with a
    /// fetch start event and finish with response end. All other events are optional.
    /// An event can be 0 because it hasn't happened yet, because it's optional or
    /// because the load failed before the event reached.
    ///
    /// Size metrics are expressed in bytes and are updated while the [`Message`][crate::Message] is
    /// being loaded. You can connect to different [`Message`][crate::Message] signals to get the
    /// final result of every value.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct MessageMetrics(Boxed<ffi::SoupMessageMetrics>);

    match fn {
        copy => |ptr| ffi::soup_message_metrics_copy(mut_override(ptr)),
        free => |ptr| ffi::soup_message_metrics_free(ptr),
        type_ => || ffi::soup_message_metrics_get_type(),
    }
}

impl MessageMetrics {
    /// Get the time immediately after the [`Message`][crate::Message] completed the
    /// connection to the server. This includes the time for the proxy
    /// negotiation and TLS handshake.
    ///
    /// It will be 0 if no network connection was required to fetch the resource (a
    /// persistent connection was used or resource was loaded from the local disk
    /// cache).
    ///
    /// # Returns
    ///
    /// the connection end time
    #[doc(alias = "soup_message_metrics_get_connect_end")]
    #[doc(alias = "get_connect_end")]
    pub fn connect_end(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_connect_end(self.to_glib_none_mut().0) }
    }

    /// Get the time immediately before the [`Message`][crate::Message] started to
    /// establish the connection to the server.
    ///
    /// It will be 0 if no network connection was required to fetch the resource (a
    /// persistent connection was used or resource was loaded from the local disk
    /// cache).
    ///
    /// # Returns
    ///
    /// the connection start time
    #[doc(alias = "soup_message_metrics_get_connect_start")]
    #[doc(alias = "get_connect_start")]
    pub fn connect_start(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_connect_start(self.to_glib_none_mut().0) }
    }

    /// Get the time immediately after the [`Message`][crate::Message] completed the
    /// domain lookup name for the resource.
    ///
    /// It will be 0 if no domain lookup was required to fetch the resource (a
    /// persistent connection was used or resource was loaded from the local disk
    /// cache).
    ///
    /// # Returns
    ///
    /// the domain lookup end time
    #[doc(alias = "soup_message_metrics_get_dns_end")]
    #[doc(alias = "get_dns_end")]
    pub fn dns_end(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_dns_end(self.to_glib_none_mut().0) }
    }

    /// Get the time immediately before the [`Message`][crate::Message] started the
    /// domain lookup name for the resource.
    ///
    /// It will be 0 if no domain lookup was required to fetch the resource (a
    /// persistent connection was used or resource was loaded from the local disk
    /// cache).
    ///
    /// # Returns
    ///
    /// the domain lookup start time
    #[doc(alias = "soup_message_metrics_get_dns_start")]
    #[doc(alias = "get_dns_start")]
    pub fn dns_start(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_dns_start(self.to_glib_none_mut().0) }
    }

    /// Get the time immediately before the [`Message`][crate::Message] started to
    /// fetch a resource either from a remote server or local disk cache.
    ///
    /// # Returns
    ///
    /// the fetch start time
    #[doc(alias = "soup_message_metrics_get_fetch_start")]
    #[doc(alias = "get_fetch_start")]
    pub fn fetch_start(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_fetch_start(self.to_glib_none_mut().0) }
    }

    /// Get the number of bytes sent to the network for the request body.
    ///
    /// This is the size of the body sent, after encodings are applied, so it might
    /// be greater than the value returned by
    /// [`request_body_size()`][Self::request_body_size()]. This value is available right
    /// before [`wrote-body`][struct@crate::Message#wrote-body] signal is emitted, but you might get an
    /// intermediate value if called before.
    ///
    /// # Returns
    ///
    /// the request body bytes sent
    #[doc(alias = "soup_message_metrics_get_request_body_bytes_sent")]
    #[doc(alias = "get_request_body_bytes_sent")]
    pub fn request_body_bytes_sent(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_request_body_bytes_sent(self.to_glib_none_mut().0) }
    }

    /// Get the request body size in bytes. This is the size of the original body
    /// given to the request before any encoding is applied.
    ///
    /// This value is available right before [`wrote-body`][struct@crate::Message#wrote-body] signal is
    /// emitted, but you might get an intermediate value if called before.
    ///
    /// # Returns
    ///
    /// the request body size
    #[doc(alias = "soup_message_metrics_get_request_body_size")]
    #[doc(alias = "get_request_body_size")]
    pub fn request_body_size(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_request_body_size(self.to_glib_none_mut().0) }
    }

    /// Get the number of bytes sent to the network for the request headers.
    ///
    /// This value is available right before [`wrote-headers`][struct@crate::Message#wrote-headers] signal
    /// is emitted, but you might get an intermediate value if called before.
    ///
    /// # Returns
    ///
    /// the request headers bytes sent
    #[doc(alias = "soup_message_metrics_get_request_header_bytes_sent")]
    #[doc(alias = "get_request_header_bytes_sent")]
    pub fn request_header_bytes_sent(&mut self) -> u64 {
        unsafe {
            ffi::soup_message_metrics_get_request_header_bytes_sent(self.to_glib_none_mut().0)
        }
    }

    /// Get the time immediately before the [`Message`][crate::Message] started the
    /// request of the resource from the server or the local disk cache.
    ///
    /// # Returns
    ///
    /// the request start time
    #[doc(alias = "soup_message_metrics_get_request_start")]
    #[doc(alias = "get_request_start")]
    pub fn request_start(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_request_start(self.to_glib_none_mut().0) }
    }

    /// Get the number of bytes received from the network for the response body.
    ///
    /// This value is available right before [`got-body`][struct@crate::Message#got-body] signal is
    /// emitted, but you might get an intermediate value if called before. For
    /// resources loaded from the disk cache this value is always 0.
    ///
    /// # Returns
    ///
    /// the response body bytes received
    #[doc(alias = "soup_message_metrics_get_response_body_bytes_received")]
    #[doc(alias = "get_response_body_bytes_received")]
    pub fn response_body_bytes_received(&mut self) -> u64 {
        unsafe {
            ffi::soup_message_metrics_get_response_body_bytes_received(self.to_glib_none_mut().0)
        }
    }

    /// Get the response body size in bytes.
    ///
    /// This is the size of the body as given to the user after all encodings are
    /// applied, so it might be greater than the value returned by
    /// [`response_body_bytes_received()`][Self::response_body_bytes_received()]. This value is
    /// available right before [`got-body`][struct@crate::Message#got-body] signal is emitted, but you
    /// might get an intermediate value if called before.
    ///
    /// # Returns
    ///
    /// the response body size
    #[doc(alias = "soup_message_metrics_get_response_body_size")]
    #[doc(alias = "get_response_body_size")]
    pub fn response_body_size(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_response_body_size(self.to_glib_none_mut().0) }
    }

    /// Get the time immediately after the [`Message`][crate::Message] received the last
    /// bytes of the response from the server or the local disk cache.
    ///
    /// In case of load failure, this returns the time immediately before the
    /// fetch is aborted.
    ///
    /// # Returns
    ///
    /// the response end time
    #[doc(alias = "soup_message_metrics_get_response_end")]
    #[doc(alias = "get_response_end")]
    pub fn response_end(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_response_end(self.to_glib_none_mut().0) }
    }

    /// Get the number of bytes received from the network for the response headers.
    ///
    /// This value is available right before [`got-headers`][struct@crate::Message#got-headers] signal
    /// is emitted, but you might get an intermediate value if called before.
    /// For resources loaded from the disk cache this value is always 0.
    ///
    /// # Returns
    ///
    /// the response headers bytes received
    #[doc(alias = "soup_message_metrics_get_response_header_bytes_received")]
    #[doc(alias = "get_response_header_bytes_received")]
    pub fn response_header_bytes_received(&mut self) -> u64 {
        unsafe {
            ffi::soup_message_metrics_get_response_header_bytes_received(self.to_glib_none_mut().0)
        }
    }

    /// Get the time immediately after the [`Message`][crate::Message] received the first
    /// bytes of the response from the server or the local disk cache.
    ///
    /// # Returns
    ///
    /// the response start time
    #[doc(alias = "soup_message_metrics_get_response_start")]
    #[doc(alias = "get_response_start")]
    pub fn response_start(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_response_start(self.to_glib_none_mut().0) }
    }

    /// Get the time immediately before the [`Message`][crate::Message] started the
    /// TLS handshake.
    ///
    /// It will be 0 if no TLS handshake was required to fetch the resource
    /// (connection was not secure, a persistent connection was used or resource was
    /// loaded from the local disk cache).
    ///
    /// # Returns
    ///
    /// the tls start time
    #[doc(alias = "soup_message_metrics_get_tls_start")]
    #[doc(alias = "get_tls_start")]
    pub fn tls_start(&mut self) -> u64 {
        unsafe { ffi::soup_message_metrics_get_tls_start(self.to_glib_none_mut().0) }
    }
}