servo-script 0.4.0

A component of the servo web-engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use dom_struct::dom_struct;
use js::context::JSContext;
use js::realm::CurrentRealm;
use js::rust::{HandleObject, HandleValue};
use script_bindings::reflector::{Reflector, reflect_dom_object_with_proto_and_cx};

use crate::dom::abortsignal::AbortSignal;
use crate::dom::bindings::codegen::Bindings::AbortControllerBinding::AbortControllerMethods;
use crate::dom::bindings::root::{Dom, DomRoot};
use crate::dom::globalscope::GlobalScope;

/// <https://dom.spec.whatwg.org/#abortcontroller>
#[dom_struct]
pub(crate) struct AbortController {
    reflector_: Reflector,

    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-signal>
    signal: Dom<AbortSignal>,
}

impl AbortController {
    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
    fn new_inherited(signal: &AbortSignal) -> AbortController {
        // Note: continuation of the constructor steps.

        // Step 2. Set this’s signal to signal.
        AbortController {
            reflector_: Reflector::new(),
            signal: Dom::from_ref(signal),
        }
    }

    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
    pub(crate) fn new_with_proto(
        cx: &mut JSContext,
        global: &GlobalScope,
        proto: Option<HandleObject>,
    ) -> DomRoot<AbortController> {
        // Step 1. Let signal be a new AbortSignal object.
        let signal = AbortSignal::new_with_proto(cx, global, None);
        // Step 2. Set this’s signal to signal.
        reflect_dom_object_with_proto_and_cx(
            Box::new(AbortController::new_inherited(&signal)),
            global,
            proto,
            cx,
        )
    }

    /// <https://dom.spec.whatwg.org/#abortcontroller-signal-abort>
    pub(crate) fn signal_abort(&self, cx: &mut CurrentRealm, reason: HandleValue) {
        // To signal abort on an AbortController controller with an optional reason,
        // signal abort on controller’s signal with reason if it is given.
        self.signal.signal_abort(cx, reason);
    }

    /// <https://dom.spec.whatwg.org/#abortcontroller-signal>
    pub(crate) fn signal(&self) -> DomRoot<AbortSignal> {
        // The signal getter steps are to return this’s signal.
        self.signal.as_rooted()
    }
}

impl AbortControllerMethods<crate::DomTypeHolder> for AbortController {
    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
    fn Constructor(
        cx: &mut JSContext,
        global: &GlobalScope,
        proto: Option<HandleObject>,
    ) -> DomRoot<AbortController> {
        AbortController::new_with_proto(cx, global, proto)
    }

    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abort>
    fn Abort(&self, cx: &mut CurrentRealm, reason: HandleValue) {
        // The abort(reason) method steps are
        // to signal abort on this with reason if it is given.
        self.signal_abort(cx, reason);
    }

    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-signal>
    fn Signal(&self) -> DomRoot<AbortSignal> {
        // The signal getter steps are to return this’s signal.
        self.signal.as_rooted()
    }
}