Struct soup::MessageMetrics

pub struct MessageMetrics { /* private fields */ }

Contains metrics collected while loading a Message either from the network or the disk cache.

Metrics are not collected by default for a Message, you need to add the flag 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 is being loaded. You can connect to different Message signals to get the final result of every value.

Implementations

impl MessageMetrics

pub fn as_ptr(&self) -> *mut SoupMessageMetrics

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const SoupMessageMetrics ) -> &'a Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut *mut SoupMessageMetrics ) -> &'a mut Self

Borrows the underlying C value mutably.

impl MessageMetrics

pub fn connect_end(&mut self) -> u64

Get the time immediately after the 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

pub fn connect_start(&mut self) -> u64

Get the time immediately before the 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

pub fn dns_end(&mut self) -> u64

Get the time immediately after the 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

pub fn dns_start(&mut self) -> u64

Get the time immediately before the 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

pub fn fetch_start(&mut self) -> u64

Get the time immediately before the Message started to fetch a resource either from a remote server or local disk cache.

Returns

the fetch start time

pub fn request_body_bytes_sent(&mut self) -> u64

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(). This value is available right before wrote-body signal is emitted, but you might get an intermediate value if called before.

Returns

the request body bytes sent

pub fn request_body_size(&mut self) -> u64

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 signal is emitted, but you might get an intermediate value if called before.

Returns

the request body size

pub fn request_header_bytes_sent(&mut self) -> u64

Get the number of bytes sent to the network for the request headers.

This value is available right before wrote-headers signal is emitted, but you might get an intermediate value if called before.

Returns

the request headers bytes sent

pub fn request_start(&mut self) -> u64

Get the time immediately before the Message started the request of the resource from the server or the local disk cache.

Returns

the request start time

pub fn response_body_bytes_received(&mut self) -> u64

Get the number of bytes received from the network for the response body.

This value is available right before 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

pub fn response_body_size(&mut self) -> u64

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(). This value is available right before got-body signal is emitted, but you might get an intermediate value if called before.

Returns

the response body size

pub fn response_end(&mut self) -> u64

Get the time immediately after the 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

pub fn response_header_bytes_received(&mut self) -> u64

Get the number of bytes received from the network for the response headers.

This value is available right before 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

pub fn response_start(&mut self) -> u64

Get the time immediately after the Message received the first bytes of the response from the server or the local disk cache.

Returns

the response start time

pub fn tls_start(&mut self) -> u64

Get the time immediately before the 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

Trait Implementations

impl Clone for MessageMetrics

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessageMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<MessageMetrics> for Value

fn from(o: MessageMetrics) -> Self

Converts to this type from the input type.

impl HasParamSpec for MessageMetrics

type ParamSpec = ParamSpecBoxed

type SetValue = MessageMetrics

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, MessageMetrics>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MessageMetrics

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MessageMetrics

fn cmp(&self, other: &MessageMetrics) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MessageMetrics

fn eq(&self, other: &MessageMetrics) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MessageMetrics

fn partial_cmp(&self, other: &MessageMetrics) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MessageMetrics

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MessageMetrics

impl StructuralPartialEq for MessageMetrics