Struct webkit2gtk::UserMessage

#[repr(transparent)]
pub struct UserMessage { /* private fields */ }

Available on crate feature v2_28 only.

Message that can be sent between the UI process and web extensions.

A WebKitUserMessage is a message that can be used for the communication between the UI process and web extensions. A WebKitUserMessage always has a name, and it can also include parameters and UNIX file descriptors. Messages can be sent from a WebContext to all WebKitWebExtensions, from a WebKitWebExtension to its corresponding WebContext, and from a WebView to its corresponding WebKitWebPage (and vice versa). One to one messages can be replied to directly with UserMessageExt::send_reply().

Implements

UserMessageExt, glib::ObjectExt

Implementations

impl UserMessage

pub const NONE: Option<&'static UserMessage> = None

pub fn new(name: &str, parameters: Option<&Variant>) -> UserMessage

Create a new UserMessage with name.

name

the message name

parameters

the message parameters as a glib::Variant, or None

Returns

the newly created UserMessage object.

pub fn with_fd_list(
    name: &str,
    parameters: Option<&Variant>,
    fd_list: Option<&impl IsA<UnixFDList>>
) -> UserMessage

Create a new UserMessage including also a list of UNIX file descriptors to be sent.

name

the message name

parameters

the message parameters as a glib::Variant

fd_list

the message file descriptors

Returns

the newly created UserMessage object.

pub fn builder() -> UserMessageBuilder

Creates a new builder-pattern struct instance to construct UserMessage objects.

This method returns an instance of UserMessageBuilder which can be used to create UserMessage objects.

Trait Implementations

impl Clone for UserMessage

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserMessage

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

Formats the value using the given formatter.

impl Default for UserMessage

fn default() -> Self

Returns the “default value” for a type.

impl Display for UserMessage

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

Formats the value using the given formatter.

impl Hash for UserMessage

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for UserMessage

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for UserMessage

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for UserMessage

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

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

const 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<OT: ObjectType> PartialOrd<OT> for UserMessage

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

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

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

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

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

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

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

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

const 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 UserMessage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for UserMessage