Struct webkit6::MemoryPressureSettings

pub struct MemoryPressureSettings { /* private fields */ }

A boxed type representing the settings for the memory pressure handler

#WebKitMemoryPressureSettings is a boxed type that can be used to provide some custom settings to control how the memory pressure situations are handled by the different processes.

The memory pressure system implemented inside the different process will try to keep the memory usage under the defined memory limit. In order to do that, it will check the used memory with a user defined frequency and decide whether it should try to release memory. The thresholds passed will define how urgent is to release that memory.

Take into account that badly defined parameters can greatly reduce the performance of the engine. For example, setting memory limit too low with a fast poll interval can cause the process to constantly be trying to release memory.

A #WebKitMemoryPressureSettings can be passed to a #WebKitWebContext constructor, and the settings will be applied to all the web processes created by that context.

A #WebKitMemoryPressureSettings can be passed to webkit_website_data_manager_set_memory_pressure_settings(), and the settings will be applied to all the network processes created after that call by any instance of #WebKitWebsiteDataManager.

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl MemoryPressureSettings

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

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow( ptr: &*mut WebKitMemoryPressureSettings, ) -> &Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut( ptr: &mut *mut WebKitMemoryPressureSettings, ) -> &mut Self

Borrows the underlying C value mutably.

impl MemoryPressureSettings

pub fn new() -> MemoryPressureSettings

Create a new #WebKitMemoryPressureSettings with the default values.

Returns

A new #WebKitMemoryPressureSettings instance filled with the default values.

pub fn conservative_threshold(&mut self) -> f64

Gets the conservative memory usage threshold.

Returns

value in the (0, 1) range.

pub fn kill_threshold(&mut self) -> f64

Gets the kill memory usage threshold.

Returns

positive value, can be zero.

pub fn memory_limit(&mut self) -> u32

Gets the memory usage limit.

Returns

current value, in megabytes.

pub fn poll_interval(&mut self) -> f64

Gets the interval at which memory usage is checked.

Returns

current interval value, in seconds.

pub fn strict_threshold(&mut self) -> f64

Gets the strict memory usage threshold.

Returns

value in the (0, 1) range.

pub fn set_conservative_threshold(&mut self, value: f64)

Sets the memory limit for the conservative policy to start working.

Sets @value as the fraction of the defined memory limit where the conservative policy starts working. This policy will try to reduce the memory footprint by releasing non critical memory.

The threshold must be bigger than 0 and smaller than 1, and it must be smaller than the strict threshold defined in @self. The default value is 0.33.

value

fraction of the memory limit where the conservative policy starts working.

pub fn set_kill_threshold(&mut self, value: f64)

Sets @value as the fraction of the defined memory limit where the process will be killed.

The threshold must be a value bigger or equal to 0. A value of 0 means that the process is never killed. If the threshold is not 0, then it must be bigger than the strict threshold defined in @self. The threshold can also have values bigger than 1. The default value is 0.

value

fraction of the memory limit where the process will be killed because of excessive memory usage.

pub fn set_memory_limit(&mut self, memory_limit: u32)

Sets @memory_limit the memory limit value to @self.

The default value is the system’s RAM size with a maximum of 3GB.

memory_limit

amount of memory (in MB) that the process is allowed to use.

pub fn set_poll_interval(&mut self, value: f64)

Sets @value as the poll interval used by @self.

The poll interval value must be bigger than 0. The default value is 30 seconds.

value

period (in seconds) between memory usage measurements.

pub fn set_strict_threshold(&mut self, value: f64)

Sets the memory limit for the strict policy to start working.

Sets @value as the fraction of the defined memory limit where the strict policy starts working. This policy will try to reduce the memory footprint by releasing critical memory.

The threshold must be bigger than 0 and smaller than 1. Also, it must be bigger than the conservative threshold defined in @self, and smaller than the kill threshold if the latter is not 0. The default value is 0.5.

value

fraction of the memory limit where the strict policy starts working.

Trait Implementations

impl Clone for MemoryPressureSettings

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for MemoryPressureSettings

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

Formats the value using the given formatter.

impl Default for MemoryPressureSettings

fn default() -> Self

Returns the “default value” for a type.

impl From<MemoryPressureSettings> for Value

fn from(o: MemoryPressureSettings) -> Self

Converts to this type from the input type.

impl HasParamSpec for MemoryPressureSettings

type ParamSpec = ParamSpecBoxed

type SetValue = MemoryPressureSettings

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MemoryPressureSettings

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 MemoryPressureSettings

fn cmp(&self, other: &MemoryPressureSettings) -> 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 MemoryPressureSettings

fn eq(&self, other: &MemoryPressureSettings) -> 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 MemoryPressureSettings

fn partial_cmp(&self, other: &MemoryPressureSettings) -> 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 MemoryPressureSettings

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MemoryPressureSettings

impl StructuralPartialEq for MemoryPressureSettings