Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-02-27 04:38:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1594304. Add deprecation notes to methods that allow throwing a bare nsresult with no useful message. r=smaug

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D53092

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Boris Zbarsky 2019-11-14 22:51:21 +00:00
parent 3d651bb90e
commit 18bee19d2c
2 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
dom/bindings/ErrorResult.h
View File

@ -164,6 +164,11 @@ class TErrorResult {
operator const ErrorResult&() const;
operator OOMReporter&();
// This method is deprecated. Consumers should ThrowDOMException if they are
// throwing a DOMException. If they have a random nsresult which may or may
// not correspond to a DOMException type, they should consider using an
// appropriate DOMException-type nsresult with an informative message and
// calling ThrowDOMException.
void MOZ_MUST_RETURN_FROM_CALLER_IF_THIS_IS_ARG Throw(nsresult rv) {
MOZ_ASSERT(NS_FAILED(rv), "Please don't try throwing success");
AssignErrorCode(rv);
@ -368,7 +373,7 @@ class TErrorResult {
// Backwards-compat to make conversion simpler. We don't call
// Throw() here because people can easily pass success codes to
// this.
// this. This operator is deprecated and ideally shouldn't be used.
void operator=(nsresult rv) { AssignErrorCode(rv); }
bool Failed() const { return NS_FAILED(mResult); }
@ -599,6 +604,7 @@ class ErrorResult : public binding_danger::TErrorResult<
explicit ErrorResult(nsresult aRv) : BaseErrorResult(aRv) {}
// This operator is deprecated and ideally shouldn't be used.
void operator=(nsresult rv) { BaseErrorResult::operator=(rv); }
ErrorResult& operator=(ErrorResult&& aRHS) {
@ -659,6 +665,7 @@ class CopyableErrorResult
explicit CopyableErrorResult(nsresult aRv) : BaseErrorResult(aRv) {}
// This operator is deprecated and ideally shouldn't be used.
void operator=(nsresult rv) { BaseErrorResult::operator=(rv); }
CopyableErrorResult& operator=(CopyableErrorResult&& aRHS) {

7
dom/promise/Promise.h
View File

@ -89,6 +89,13 @@ class Promise : public nsISupports, public SupportsWeakPtr<Promise> {
void MaybeReject(JS::Handle<JS::Value> aValue) {
MaybeSomething(aValue, &Promise::MaybeReject);
}
// This method is deprecated. Consumers should MaybeRejectWithDOMException if
// they are rejecting with a DOMException, or use one of the other
// MaybeReject* methods otherwise. If they have a random nsresult which may
// or may not correspond to a DOMException type, they should consider using an
// appropriate DOMException-type nsresult with an informative message and
// calling MaybeRejectWithDOMException.
inline void MaybeReject(nsresult aArg) {
MOZ_ASSERT(NS_FAILED(aArg));
MaybeSomething(aArg, &Promise::MaybeReject);