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    /// An AbortController object has an associated signal (an AbortSignal object).
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        // 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        // The new AbortController() constructor steps are:
44        // Let signal be a new AbortSignal object.
45        let signal = AbortSignal::new_with_proto(global, None, can_gc);
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        // signal abort on controller’s signal with reason if it is given.
63        self.signal.signal_abort(cx, reason, realm, can_gc);
64    }
65
66    /// <https://dom.spec.whatwg.org/#abortcontroller-signal>
67    pub(crate) fn signal(&self) -> DomRoot<AbortSignal> {
68        // The signal getter steps are to return this’s signal.
69        self.signal.as_rooted()
70    }
71}
72
73impl AbortControllerMethods<crate::DomTypeHolder> for AbortController {
74    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
75    fn Constructor(
76        global: &GlobalScope,
77        proto: Option<HandleObject>,
78        can_gc: CanGc,
79    ) -> DomRoot<AbortController> {
80        AbortController::new_with_proto(global, proto, can_gc)
81    }
82
83    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abort>
84    fn Abort(&self, cx: JSContext, reason: HandleValue, realm: InRealm, can_gc: CanGc) {
85        // The abort(reason) method steps are
86        // to signal abort on this with reason if it is given.
87        self.signal_abort(cx, reason, realm, can_gc);
88    }
89
90    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-signal>
91    fn Signal(&self) -> DomRoot<AbortSignal> {
92        // The signal getter steps are to return this’s signal.
93        self.signal.as_rooted()
94    }
95}
script/dom/abortcontroller.rs

script/dom/
abortcontroller.rs
