Struct chromiumoxide::cdp::js_protocol::runtime::EvaluateParams

pub struct EvaluateParams {

    pub expression: String,
    pub object_group: Option<String>,
    pub include_command_line_api: Option<bool>,
    pub silent: Option<bool>,
    pub context_id: Option<ExecutionContextId>,
    pub return_by_value: Option<bool>,
    pub generate_preview: Option<bool>,
    pub user_gesture: Option<bool>,
    pub await_promise: Option<bool>,
    pub throw_on_side_effect: Option<bool>,
    pub timeout: Option<TimeDelta>,
    pub disable_breaks: Option<bool>,
    pub repl_mode: Option<bool>,
    pub allow_unsafe_eval_blocked_by_csp: Option<bool>,
    pub unique_context_id: Option<String>,
    pub generate_web_driver_value: Option<bool>,
    pub eval_as_function_fallback: Option<bool>,
}

Evaluates expression on global object. evaluate

Fields

expression: String

Expression to evaluate.

object_group: Option<String>

Symbolic group name that can be used to release multiple objects.

include_command_line_api: Option<bool>

Determines whether Command Line API should be available during the evaluation.

silent: Option<bool>

In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.

context_id: Option<ExecutionContextId>

Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page. This is mutually exclusive with uniqueContextId, which offers an alternative way to identify the execution context that is more reliable in a multi-process environment.

return_by_value: Option<bool>

Whether the result is expected to be a JSON object that should be sent by value.

generate_preview: Option<bool>

Whether preview should be generated for the result.

user_gesture: Option<bool>

Whether execution should be treated as initiated by user in the UI.

await_promise: Option<bool>

Whether execution should await for resulting value and return once awaited promise is resolved.

throw_on_side_effect: Option<bool>

Whether to throw an exception if side effect cannot be ruled out during evaluation. This implies disableBreaks below.

timeout: Option<TimeDelta>

Terminate execution after timing out (number of milliseconds).

disable_breaks: Option<bool>

Disable breakpoints during execution.

repl_mode: Option<bool>

Setting this flag to true enables let re-declaration and top-level await. Note that let variables can only be re-declared if they originate from replMode themselves.

allow_unsafe_eval_blocked_by_csp: Option<bool>

The Content Security Policy (CSP) for the target might block ‘unsafe-eval’ which includes eval(), Function(), setTimeout() and setInterval() when called with non-callable arguments. This flag bypasses CSP for this evaluation and allows unsafe-eval. Defaults to true.

unique_context_id: Option<String>

An alternative way to specify the execution context to evaluate in. Compared to contextId that may be reused across processes, this is guaranteed to be system-unique, so it can be used to prevent accidental evaluation of the expression in context different than intended (e.g. as a result of navigation across process boundaries). This is mutually exclusive with contextId.

generate_web_driver_value: Option<bool>

Whether the result should be serialized according to https://w3c.github.io/webdriver-bidi.

eval_as_function_fallback: Option<bool>

This is a manually added field that is not part of the protocol definition, hence ignored during serde operations.

If set to true, this field indicates, that if the command resulted in a response value of type function this, EvaluateParams command should be executed as a CallFunctionOnParams instead.

Implementations

impl EvaluateParams

pub fn new(expression: impl Into<String>) -> EvaluateParams

impl EvaluateParams

pub fn builder() -> EvaluateParamsBuilder

impl EvaluateParams

pub const IDENTIFIER: &'static str = "Runtime.evaluate"

Trait Implementations

impl Clone for EvaluateParams

fn clone(&self) -> EvaluateParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Command for EvaluateParams

type Response = EvaluateReturns

The type of the response this request triggers on the chromium server

fn response_from_value(response: Value) -> Result<Self::Response, Error>

deserialize the response from json

impl Debug for EvaluateParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EvaluateParams

fn deserialize<__D>( __deserializer: __D ) -> Result<EvaluateParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EvaluateParams> for CallFunctionOnParams

fn from(params: EvaluateParams) -> CallFunctionOnParams

Converts to this type from the input type.

impl From<EvaluateParams> for Evaluation

fn from(params: EvaluateParams) -> Self

Converts to this type from the input type.

impl<T> From<T> for EvaluateParams

where T: Into<String>,

fn from(url: T) -> EvaluateParams

Converts to this type from the input type.

impl Method for EvaluateParams

fn identifier(&self) -> Cow<'static, str>

The whole string identifier for this method like: DOM.removeNode

fn domain_name(&self) -> Cow<'static, str>

The name of the domain this method belongs to: DOM

fn method_name(&self) -> Cow<'static, str>

The standalone identifier of the method inside the domain: removeNode

fn split(&self) -> (Cow<'static, str>, Cow<'static, str>)

Tuple of (domain_name, method_name) : (DOM, removeNode)

impl MethodType for EvaluateParams

fn method_id() -> Cow<'static, str>

where EvaluateParams: Sized,

The identifier for this event’s method field

impl PartialEq for EvaluateParams

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

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EvaluateParams