script/dom/
abortcontroller.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use dom_struct::dom_struct;
6use js::rust::{HandleObject, HandleValue};
7
8use crate::dom::abortsignal::AbortSignal;
9use crate::dom::bindings::codegen::Bindings::AbortControllerBinding::AbortControllerMethods;
10use crate::dom::bindings::reflector::{Reflector, reflect_dom_object_with_proto};
11use crate::dom::bindings::root::{Dom, DomRoot};
12use crate::dom::globalscope::GlobalScope;
13use crate::realms::InRealm;
14use crate::script_runtime::{CanGc, JSContext};
15
16/// <https://dom.spec.whatwg.org/#abortcontroller>
17#[dom_struct]
18pub(crate) struct AbortController {
19    reflector_: Reflector,
20
21    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-signal>
22    signal: Dom<AbortSignal>,
23}
24
25impl AbortController {
26    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
27    fn new_inherited(signal: &AbortSignal) -> AbortController {
28        // Note: continuation of the constructor steps.
29
30        // Step 2. Set this’s signal to signal.
31        AbortController {
32            reflector_: Reflector::new(),
33            signal: Dom::from_ref(signal),
34        }
35    }
36
37    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
38    pub(crate) fn new_with_proto(
39        global: &GlobalScope,
40        proto: Option<HandleObject>,
41        can_gc: CanGc,
42    ) -> DomRoot<AbortController> {
43        // Step 1. Let signal be a new AbortSignal object.
44        let signal = AbortSignal::new_with_proto(global, None, can_gc);
45        // Step 2. Set this’s signal to signal.
46        reflect_dom_object_with_proto(
47            Box::new(AbortController::new_inherited(&signal)),
48            global,
49            proto,
50            can_gc,
51        )
52    }
53
54    /// <https://dom.spec.whatwg.org/#abortcontroller-signal-abort>
55    pub(crate) fn signal_abort(
56        &self,
57        cx: JSContext,
58        reason: HandleValue,
59        realm: InRealm,
60        can_gc: CanGc,
61    ) {
62        // To signal abort on an AbortController controller with an optional reason,
63        // signal abort on controller’s signal with reason if it is given.
64        self.signal.signal_abort(cx, reason, realm, can_gc);
65    }
66
67    /// <https://dom.spec.whatwg.org/#abortcontroller-signal>
68    pub(crate) fn signal(&self) -> DomRoot<AbortSignal> {
69        // The signal getter steps are to return this’s signal.
70        self.signal.as_rooted()
71    }
72}
73
74impl AbortControllerMethods<crate::DomTypeHolder> for AbortController {
75    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
76    fn Constructor(
77        global: &GlobalScope,
78        proto: Option<HandleObject>,
79        can_gc: CanGc,
80    ) -> DomRoot<AbortController> {
81        AbortController::new_with_proto(global, proto, can_gc)
82    }
83
84    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abort>
85    fn Abort(&self, cx: JSContext, reason: HandleValue, realm: InRealm, can_gc: CanGc) {
86        // The abort(reason) method steps are
87        // to signal abort on this with reason if it is given.
88        self.signal_abort(cx, reason, realm, can_gc);
89    }
90
91    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-signal>
92    fn Signal(&self) -> DomRoot<AbortSignal> {
93        // The signal getter steps are to return this’s signal.
94        self.signal.as_rooted()
95    }
96}
script/dom/abortcontroller.rs

script/dom/
abortcontroller.rs
