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::realm::CurrentRealm;
7use js::rust::{HandleObject, HandleValue};
8
9use crate::dom::abortsignal::AbortSignal;
10use crate::dom::bindings::codegen::Bindings::AbortControllerBinding::AbortControllerMethods;
11use crate::dom::bindings::reflector::{Reflector, reflect_dom_object_with_proto};
12use crate::dom::bindings::root::{Dom, DomRoot};
13use crate::dom::globalscope::GlobalScope;
14use crate::script_runtime::CanGc;
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(&self, cx: &mut CurrentRealm, reason: HandleValue) {
56        // To signal abort on an AbortController controller with an optional reason,
57        // signal abort on controller’s signal with reason if it is given.
58        self.signal.signal_abort(cx, reason);
59    }
60
61    /// <https://dom.spec.whatwg.org/#abortcontroller-signal>
62    pub(crate) fn signal(&self) -> DomRoot<AbortSignal> {
63        // The signal getter steps are to return this’s signal.
64        self.signal.as_rooted()
65    }
66}
67
68impl AbortControllerMethods<crate::DomTypeHolder> for AbortController {
69    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abortcontroller>
70    fn Constructor(
71        global: &GlobalScope,
72        proto: Option<HandleObject>,
73        can_gc: CanGc,
74    ) -> DomRoot<AbortController> {
75        AbortController::new_with_proto(global, proto, can_gc)
76    }
77
78    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-abort>
79    fn Abort(&self, cx: &mut CurrentRealm, reason: HandleValue) {
80        // The abort(reason) method steps are
81        // to signal abort on this with reason if it is given.
82        self.signal_abort(cx, reason);
83    }
84
85    /// <https://dom.spec.whatwg.org/#dom-abortcontroller-signal>
86    fn Signal(&self) -> DomRoot<AbortSignal> {
87        // The signal getter steps are to return this’s signal.
88        self.signal.as_rooted()
89    }
90}
script/dom/abortcontroller.rs

script/dom/
abortcontroller.rs
