pub enum FrameRequest {
Show 28 variants CreateView { view_token: ViewToken, control_handle: FrameControlHandle, }, CreateViewWithViewRef { view_token: ViewToken, view_ref_control: ViewRefControl, view_ref: ViewRef, control_handle: FrameControlHandle, }, CreateView2 { args: CreateView2Args, control_handle: FrameControlHandle, }, EnableHeadlessRendering { control_handle: FrameControlHandle, }, DisableHeadlessRendering { control_handle: FrameControlHandle, }, GetMediaPlayer { player: ServerEnd<PlayerMarker>, control_handle: FrameControlHandle, }, GetNavigationController { controller: ServerEnd<NavigationControllerMarker>, control_handle: FrameControlHandle, }, ExecuteJavaScript { origins: Vec<String>, script: Buffer, responder: FrameExecuteJavaScriptResponder, }, ExecuteJavaScriptNoResult { origins: Vec<String>, script: Buffer, responder: FrameExecuteJavaScriptNoResultResponder, }, AddBeforeLoadJavaScript { id: u64, origins: Vec<String>, script: Buffer, responder: FrameAddBeforeLoadJavaScriptResponder, }, RemoveBeforeLoadJavaScript { id: u64, control_handle: FrameControlHandle, }, PostMessage { target_origin: String, message: WebMessage, responder: FramePostMessageResponder, }, SetNavigationEventListener { listener: Option<ClientEnd<NavigationEventListenerMarker>>, control_handle: FrameControlHandle, }, SetNavigationEventListener2 { listener: Option<ClientEnd<NavigationEventListenerMarker>>, flags: NavigationEventListenerFlags, control_handle: FrameControlHandle, }, SetJavaScriptLogLevel { level: ConsoleLogLevel, control_handle: FrameControlHandle, }, SetConsoleLogSink { sink: Option<ClientEnd<LogSinkMarker>>, control_handle: FrameControlHandle, }, ConfigureInputTypes { types: InputTypes, allow: AllowInputState, control_handle: FrameControlHandle, }, SetPopupFrameCreationListener { listener: Option<ClientEnd<PopupFrameCreationListenerMarker>>, control_handle: FrameControlHandle, }, SetUrlRequestRewriteRules { rules: Vec<UrlRequestRewriteRule>, responder: FrameSetUrlRequestRewriteRulesResponder, }, SetMediaSettings { settings: FrameMediaSettings, control_handle: FrameControlHandle, }, ForceContentDimensions { web_dips: Option<Box<Vec2>>, control_handle: FrameControlHandle, }, SetPermissionState { permission: PermissionDescriptor, web_origin: String, state: PermissionState, control_handle: FrameControlHandle, }, SetBlockMediaLoading { blocked: bool, control_handle: FrameControlHandle, }, GetPrivateMemorySize { responder: FrameGetPrivateMemorySizeResponder, }, SetNavigationPolicyProvider { params: NavigationPolicyProviderParams, provider: ClientEnd<NavigationPolicyProviderMarker>, control_handle: FrameControlHandle, }, SetContentAreaSettings { settings: ContentAreaSettings, control_handle: FrameControlHandle, }, ResetContentAreaSettings { control_handle: FrameControlHandle, }, Close { payload: FrameCloseRequest, control_handle: FrameControlHandle, },
}

Variants§

§

CreateView

Fields

§view_token: ViewToken
§control_handle: FrameControlHandle

Creates a new view using the specified view_token. Caller should pass the other end of the token to [fuchsia.ui.gfx/ViewHolderArgs] to attach the new view to a view tree.

See the description of [CreateContextParams.service_directory] for additional services that must be present when using this method.

§

CreateViewWithViewRef

Fields

§view_token: ViewToken
§view_ref_control: ViewRefControl
§view_ref: ViewRef
§control_handle: FrameControlHandle

Creates a new view using the specified view_token. Caller should pass the other end of the token to [fuchsia.ui.gfx/ViewHolderArgs] to attach the new view to a view tree. view_ref can be cloned before passing it to this method, which will allow clients to track the view.

view_ref_control must not have the ZX_RIGHT_DUPLICATE set, or view creation will fail and view_token will be closed.

See the description of [CreateContextParams.service_directory] for additional services that must be present when using this method.

§

CreateView2

Fields

§control_handle: FrameControlHandle

Creates a new Flatland view using the specified view_creation_token defined under args. Caller should pass the other end of the token to [fuchsia.ui.composition/Flatland.CreateViewport] to attach the new Flatland view to its graph.

§

EnableHeadlessRendering

Fields

§control_handle: FrameControlHandle

Enables headless rendering of the Frame.

This is used when content depends on layout and/or animation events firing normally. May only be used on a Context created with [ContextFeatureFlags.HEADLESS].

§

DisableHeadlessRendering

Fields

§control_handle: FrameControlHandle

Stops headless rendering of the Frame.

May only be used on a Context created with [ContextFeatureFlags.HEADLESS].

§

GetMediaPlayer

Fields

§player: ServerEnd<PlayerMarker>
§control_handle: FrameControlHandle

Returns a [fuchsia.media.sessions2/Player] interface through which media (i.e. video/audio) playback in the frame may be observed, and/or controlled. Only one [fuchsia.media.sessions2/Player] may be active at a time, for each [Frame].

§

GetNavigationController

Fields

§controller: ServerEnd<NavigationControllerMarker>
§control_handle: FrameControlHandle

Returns an interface through which the [Frame] may be navigated to a desired URL, reloaded, etc.

  • controller: An asynchronous interface request for the [Frame]’s [NavigationController].
§

ExecuteJavaScript

Fields

§origins: Vec<String>
§script: Buffer

Executes a UTF-8 encoded script in the [Frame] if the [Frame]’s URL has an origin which matches entries in origins.

At least one origins entry must be specified. If a wildcard "*" is specified in origins, then the script will be evaluated unconditionally.

Returns the result of executing script, as a JSON-encoded string.

Note that scripts share the same execution context as the document, meaning that document may modify variables, classes, or objects set by the script in arbitrary or unpredictable ways.

If an error occurred, the FrameError will be set to one of these values:

  • BUFFER_NOT_UTF8: script is not UTF-8 encoded.
  • INVALID_ORIGIN: The [Frame]’s current URL does not match any of the values in origins or origins is an empty vector.
§

ExecuteJavaScriptNoResult

Variant of [Frame.ExecuteJavaScript] which executes the supplied script without returning a result.

§

AddBeforeLoadJavaScript

Executes a UTF-8 encoded script for every subsequent page load where the [Frame]’s URL has an origin reflected in origins. The script is executed early, prior to the execution of the document’s scripts.

Scripts are identified by a client-managed identifier id. Any script previously injected using the same id will be replaced.

The order in which multiple bindings are executed is the same as the order in which the bindings were added. If a script is added which clobbers an existing script of the same id, the previous script’s precedence in the injection order will be preserved.

At least one origins entry must be specified. If a wildcard "*" is specified in origins, then the script will be evaluated unconditionally.

If an error occurred, the FrameError will be set to one of these values:

  • BUFFER_NOT_UTF8: script is not UTF-8 encoded.
  • INVALID_ORIGIN: origins is an empty vector.
§

RemoveBeforeLoadJavaScript

Fields

§id: u64
§control_handle: FrameControlHandle

Removes a previously added JavaScript snippet identified by id. This is a no-op if there is no JavaScript snippet identified by id.

§

PostMessage

Fields

§target_origin: String
§message: WebMessage

Posts a message to the frame’s onMessage handler.

target_origin restricts message delivery to the specified origin. If target_origin is "*", then the message will be sent to the document regardless of its origin. See the HTML spec section 9.4.3 for more details on how the target origin policy is applied.

If an error occurred, the FrameError will be set to one of these values:

  • INTERNAL_ERROR: The WebEngine failed to create a message pipe.
  • BUFFER_NOT_UTF8: The script in message’s data property is not UTF-8 encoded.
  • INVALID_ORIGIN: origins is an empty vector.
  • NO_DATA_IN_MESSAGE: The data property is missing in message.
§

SetNavigationEventListener

Fields

§control_handle: FrameControlHandle

Sets the listener for handling page navigation events.

  • listener: The observer to use. Unregisters any existing listener if null.
§

SetNavigationEventListener2

Sets the listener for handling page navigation events. The listener will receive the current navigation state immediately. After that, it’s notified whenever the state changes.

  • listener: The observer to use. Unregisters any existing listener if null.
  • flags: Flags for optional features that should be enabled for the listener.
§

SetJavaScriptLogLevel

Fields

§control_handle: FrameControlHandle

If set to a value other than [ConsoleLogLevel.NONE], allows web content to log messages to the [fuchsia.logger/LogSink] configured for this [Frame], via the console object (e.g. using debug(), log(), info(), warn() and error()). The default value is [ConsoleLogLevel.NONE].

As the system log may be persisted, it is recommended that [ConsoleLogLevel.NONE] be used in Incognito and other private browsing modes.

Log lines are written to the [fuchsia.logger/LogsSink] configured for this [fuchsia.web/Frame], with severities mapped as follows:

  • debug(), log() and info() are logged at [fuchsia.logger/LogLevelFilter.INFO] severity.
  • warn() is logged at [fuchsia.logger/LogLevelFilter.WARN] severity.
  • error() is logged at [fuchsia.logger/LogLevelFilter.ERROR] severity.
§

SetConsoleLogSink

Fields

§sink: Option<ClientEnd<LogSinkMarker>>
§control_handle: FrameControlHandle

Specifies where to emit console log output to. By default log output will be routed to a [fuchsia.logger/LogSink] obtained via the [fuchsia.web/Context]’s service directory.

  • sink: The [fuchsia.logger/LogSink] to use to emit logs. Passing a null handle resets logging to use the default [fuchsia.logger/LogSink].
§

ConfigureInputTypes

Fields

§control_handle: FrameControlHandle

Enables or disables the processing of the specified types of user inputs. allow specifies whether to enable or disable the specified types. All input types are enabled by default.

§

SetPopupFrameCreationListener

Fields

§control_handle: FrameControlHandle

Sets the listener for handling popup frame opened by web content. If no listener is present, then any new popup frame will be blocked.

  • listener: The listener to use. Unregisters any existing listener if null.
§

SetUrlRequestRewriteRules

Supplies a set of UrlRequestRewriteRule to apply on every subsequent URL request.

  • rules are cumulative and applied in order.
  • rules are only applied on the first URL request in a redirect chain.
  • rules will be validated before being applied. If rules are invalid, the [Frame] will be closed with ERR_INVALID_ARGS.
  • [Frame.SetUrlRequestRewriteRules] must not be called again until its acknowledgement callback has been processed. If this happens, the [Frame] will be closed with ERR_BAD_STATE.
§

SetMediaSettings

Fields

§control_handle: FrameControlHandle

Sets [fuchsia.media/FrameMediaSettings] for the frame. The specified parameters are applied to audio streams that started after this message is processed. Should be called before the Frame is navigated to content in order to ensure that the settings applied to all media streams. Due to request pipelining, this means doing so before calling [Frame.GetNavigationController()] and [NavigationController.LoadUrl()].

§

ForceContentDimensions

Fields

§web_dips: Option<Box<Vec2>>
§control_handle: FrameControlHandle

Overrides the dimensions reported to web content. The devicePixelRatio reported to web content will be adjusted in response to changes in the pixel size of the View, rather than changing the size reported to the content. Call with null web_dips to remove any prior forced content dimensions.

§

SetPermissionState

Fields

§web_origin: String
§control_handle: FrameControlHandle

Sets the permission state for the specified permission and web_origin. By default, all permissions are denied.

§

SetBlockMediaLoading

Fields

§blocked: bool
§control_handle: FrameControlHandle

Sets whether to block all HTMLMediaElements in the frame from fetching and loading media resources.

May be used, for example, to prevent loading media in frames that are not visible.

While media loading is blocked, elements with autoplay set to true will not start playback. The promises returned by calls to play() will remain unresolved until loading is unblocked by a call to this method.

When media loading is unblocked, elements will begin fetching, resource, loading, and playing as appropriate.

Any elements that have begun fetching or loading media resources for the current source before media loading was blocked will continue to fetch, load, and start playback as appropriate. This includes calls to play() even after media loading is blocked.

§

GetPrivateMemorySize

Returns the amount of private (non-shared) physical memory used by the Frame’s main document. The returned size might not reflect the memory usage of embedded iframes.

§

SetNavigationPolicyProvider

Sets the navigation policy provider for the [Frame]. When set, the [Frame] sends [NavigationPolicyProvider.EvaluateRequestedNavigation] when processing navigation requests. params defines when the message is sent. After sending the EvaluateRequestedNavigation message, the [Frame] blocks the corresponding navigation until it receives a response.

Should be called before GetNavigationController to ensure that it is applied to all navigations including the first [NavigationController.LoadURL] request.

§

SetContentAreaSettings

Fields

§control_handle: FrameControlHandle

Sets various settings for how web content should be run in the Frame. May be called at any time, including after the URL has loaded. Each call changes only the specified fields, overwriting any prior value.

This method will fail with ZX_ERR_NOT_SUPPORTED if any value in ContentAreaSettings is not supported by the Frame.

§

ResetContentAreaSettings

Fields

§control_handle: FrameControlHandle

Reset the Frame’s ContentAreaSettings to default values.

§

Close

Fields

§control_handle: FrameControlHandle

Request graceful or immediate teardown of the Frame content and notification of completion via Frame epitaph.

Graceful teardown allows unload and cleanup tasks in the implementation and web content (e.g., unload event handlers) to run for up to the specified period of time. Immediate teardown only runs the minimum cleanup tasks in the implementation and does not allow web content to run event handlers.

  • If timeout is zero, an immediate teardown is initiated. The channel will close with ZX_OK. This is equivalent to the caller closing the Frame channel.

  • If timeout is non-zero, a graceful teardown is initiated. The channel will close with ZX_OK if the Frame closes within the specified timeout and with ZX_ERR_TIMED_OUT otherwise.

  • If timeout is not specified, a reasonable implementation-specific timeout is applied.

Subsequent calls to Close() will override any previously specified Close() timeout.

Implementations§

source§

impl FrameRequest

source

pub fn into_create_view(self) -> Option<(ViewToken, FrameControlHandle)>

source

pub fn into_create_view_with_view_ref( self ) -> Option<(ViewToken, ViewRefControl, ViewRef, FrameControlHandle)>

source

pub fn into_create_view2(self) -> Option<(CreateView2Args, FrameControlHandle)>

source

pub fn into_enable_headless_rendering(self) -> Option<FrameControlHandle>

source

pub fn into_disable_headless_rendering(self) -> Option<FrameControlHandle>

source

pub fn into_get_media_player( self ) -> Option<(ServerEnd<PlayerMarker>, FrameControlHandle)>

source

pub fn into_get_navigation_controller( self ) -> Option<(ServerEnd<NavigationControllerMarker>, FrameControlHandle)>

source

pub fn into_execute_java_script( self ) -> Option<(Vec<String>, Buffer, FrameExecuteJavaScriptResponder)>

source

pub fn into_execute_java_script_no_result( self ) -> Option<(Vec<String>, Buffer, FrameExecuteJavaScriptNoResultResponder)>

source

pub fn into_add_before_load_java_script( self ) -> Option<(u64, Vec<String>, Buffer, FrameAddBeforeLoadJavaScriptResponder)>

source

pub fn into_remove_before_load_java_script( self ) -> Option<(u64, FrameControlHandle)>

source

pub fn into_post_message( self ) -> Option<(String, WebMessage, FramePostMessageResponder)>

source

pub fn into_set_navigation_event_listener( self ) -> Option<(Option<ClientEnd<NavigationEventListenerMarker>>, FrameControlHandle)>

source

pub fn into_set_navigation_event_listener2( self ) -> Option<(Option<ClientEnd<NavigationEventListenerMarker>>, NavigationEventListenerFlags, FrameControlHandle)>

source

pub fn into_set_java_script_log_level( self ) -> Option<(ConsoleLogLevel, FrameControlHandle)>

source

pub fn into_set_console_log_sink( self ) -> Option<(Option<ClientEnd<LogSinkMarker>>, FrameControlHandle)>

source

pub fn into_configure_input_types( self ) -> Option<(InputTypes, AllowInputState, FrameControlHandle)>

source

pub fn into_set_popup_frame_creation_listener( self ) -> Option<(Option<ClientEnd<PopupFrameCreationListenerMarker>>, FrameControlHandle)>

source

pub fn into_set_url_request_rewrite_rules( self ) -> Option<(Vec<UrlRequestRewriteRule>, FrameSetUrlRequestRewriteRulesResponder)>

source

pub fn into_set_media_settings( self ) -> Option<(FrameMediaSettings, FrameControlHandle)>

source

pub fn into_force_content_dimensions( self ) -> Option<(Option<Box<Vec2>>, FrameControlHandle)>

source

pub fn into_set_permission_state( self ) -> Option<(PermissionDescriptor, String, PermissionState, FrameControlHandle)>

source

pub fn into_set_block_media_loading(self) -> Option<(bool, FrameControlHandle)>

source

pub fn into_get_private_memory_size( self ) -> Option<FrameGetPrivateMemorySizeResponder>

source

pub fn into_set_navigation_policy_provider( self ) -> Option<(NavigationPolicyProviderParams, ClientEnd<NavigationPolicyProviderMarker>, FrameControlHandle)>

source

pub fn into_set_content_area_settings( self ) -> Option<(ContentAreaSettings, FrameControlHandle)>

source

pub fn into_reset_content_area_settings(self) -> Option<FrameControlHandle>

source

pub fn into_close(self) -> Option<(FrameCloseRequest, FrameControlHandle)>

source

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations§

source§

impl Debug for FrameRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more