Struct webkit6::Feature

pub struct Feature { /* private fields */ }

Available on crate feature v2_42 only.

Describes a web engine feature that may be toggled at runtime.

The WebKit web engine includes a set of features which may be toggled programmatically, each one represented by a #WebKitFeature that provides information about it:

• A unique “identifier”: identifier().
• A “default value”, which indicates whether the option is enabled automatically: is_default_value().
• Its “status”, which determines whether it should be considered user-settable and its development stage (see FeatureStatus for details): status().
• A category, which may be used to group features together: category().
• An optional short “name” which can be presented to an user: name().
• An optional longer “detailed” description: details().

The lists of available features can be obtained with get_all_features(), get_experimental_features(), and get_development_features()). As a rule of thumb, applications which may want to allow users (i.e. web developers) to test WebKit features should use the list of experimental features. Additionally, applications might want to expose development features when targeting technically inclined users for early testing of in-development features (i.e. in “technology preview” or “canary” builds).

Applications must not expose the list of all features to end users because they often lack descriptions and control parts of the web engine which are either intended to be used during development of WebKit itself, or in specific scenarios to tweak how WebKit integrates with the application.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl Feature

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

impl Feature

pub fn category(&self) -> Option<GString>

Gets the category of the feature.

Applications which include user interface to toggle features may want to use the category to group related features together.

Returns

Feature category.

pub fn is_default_value(&self) -> bool

Gets whether the feature is enabled by default.

The default value may be used by applications which include user interface to toggle features to restore its settings to their defaults. Note that whether a feature is actually enabled must be checked with Settings::is_feature_enabled().

Returns

Whether the feature is enabled by default.

pub fn details(&self) -> Option<GString>

Gets a description for the @self.

The detailed description should be considered an additional clarification on the purpose of the feature, to be used as complementary aid to be displayed along the feature name returned by name(). The returned string is suitable to be displayed to end users, but it should not be relied upon being localized.

Note that some features may not have a detailed description, and @NULL is returned in this case.

Returns

Feature description.

pub fn identifier(&self) -> Option<GString>

Gets a string that uniquely identifies the @self.

Returns

The identifier string for the feature.

pub fn name(&self) -> Option<GString>

Gets a short name for the @self.

The returned string is suitable to be displayed to end users, but it should not be relied upon being localized.

Note that some features may not have a short name, and @NULL is returned in this case.

Returns

Short feature name.

pub fn status(&self) -> FeatureStatus

Gets the status of the feature.

Returns

Feature status.

Trait Implementations

impl Clone for Feature

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for Feature

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

Formats the value using the given formatter.

impl From<Feature> for Value

fn from(s: Feature) -> Self

Converts to this type from the input type.

impl HasParamSpec for Feature

type ParamSpec = ParamSpecBoxed

type SetValue = Feature

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Feature

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 Feature

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Feature

impl StructuralPartialEq for Feature