@sapphire/result 2.7.4-next.ee9cdb94 → 2.8.0-next.6abc5522

package/dist/iife/index.global.js

@@ -42,6 +42,7 @@ var SapphireResult = (function (exports) {
   // src/lib/Result.ts
   var ValueProperty = Symbol.for("@sapphire/result:Result.value");
   var SuccessProperty = Symbol.for("@sapphire/result:Result.success");
+  var UnwrapSafeProperty = Symbol.for("@sapphire/result:Result.safeUnwrap");
   var _a, _b;
   var _Result = class _Result {
     constructor(value, success) {
@@ -468,6 +469,7 @@ var SapphireResult = (function (exports) {
      * @seealso {@link unwrapOrElse}
      * @seealso {@link unwrapErr}
      * @seealso {@link unwrapRaw}
+     * @seealso {@link unwrapSafe}
      *
      * @example
      * ```typescript
@@ -498,6 +500,7 @@ var SapphireResult = (function (exports) {
      * @seealso {@link unwrapOr}
      * @seealso {@link unwrapOrElse}
      * @seealso {@link unwrapRaw}
+     * @seealso {@link unwrapSafe}
      *
      * @example
      * ```typescript
@@ -529,6 +532,7 @@ var SapphireResult = (function (exports) {
      * @seealso {@link unwrapOrElse}
      * @seealso {@link unwrapErr}
      * @seealso {@link unwrapRaw}
+     * @seealso {@link unwrapSafe}
      *
      * @param defaultValue The default value.
      *
@@ -554,6 +558,7 @@ var SapphireResult = (function (exports) {
      * @seealso {@link unwrapOr}
      * @seealso {@link unwrapErr}
      * @seealso {@link unwrapRaw}
+     * @seealso {@link unwrapSafe}
      *
      * @param op The predicate.
      *
@@ -578,6 +583,7 @@ var SapphireResult = (function (exports) {
      * @seealso {@link unwrapOr}
      * @seealso {@link unwrapOrElse}
      * @seealso {@link unwrapErr}
+     * @seealso {@link unwrapSafe}
      *
      * @example
      * ```typescript
@@ -598,6 +604,26 @@ var SapphireResult = (function (exports) {
       if (this.isErr()) throw this[ValueProperty];
       return this[ValueProperty];
     }
+    /**
+     * Returns the contained `Ok` value or yelds the contained `Err` value.
+     * Emulates Rust's `?` operator in `safeTry`'s body. See also {@link Result.safeTry}.
+     *
+     * If used outside of a `safeTry`'s' body, throws the contained error.
+     * @seealso {@link unwrap}
+     * @seealso {@link unwrapOr}
+     * @seealso {@link unwrapErr}
+     * @seealso {@link unwrapRaw}
+     * @seealso {@link unwrapSafe}
+     *
+     * @see {@link https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap_safe}
+     */
+    *unwrapSafe() {
+      if (this.isOk()) {
+        return this[ValueProperty];
+      }
+      yield this;
+      throw new ResultError("Should not be used outside of a safe try generator", this[ValueProperty]);
+    }
     /**
      * Returns `result` if the result is `Ok`, otherwise returns the `Err` value of itself.
      * @param result The result to check.
@@ -872,6 +898,16 @@ var SapphireResult = (function (exports) {
     get [Symbol.toStringTag]() {
       return this.match({ ok: /* @__PURE__ */ __name(() => "Ok", "ok"), err: /* @__PURE__ */ __name(() => "Err", "err") });
     }
+    /**
+     * This function, in combination with `[$]`, is intended to emulate
+     * Rust's ? operator.
+     *
+     * @see {@link Result.safeTry}
+     * @see {@link https://doc.rust-lang.org/std/result/enum.Result.html#method.safeTry}
+     */
+    get [UnwrapSafeProperty]() {
+      return this.unwrapSafe();
+    }
     // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
     static ok(value) {
       return new _Result(value, true);
@@ -991,6 +1027,13 @@ var SapphireResult = (function (exports) {
       }
       return err(errors);
     }
+    static safeTry(body) {
+      const n = body({ $: UnwrapSafeProperty, $async: unwrapSafeAsync }).next();
+      if (n instanceof Promise) {
+        return n.then((r) => r.value);
+      }
+      return n.value;
+    }
   };
   __name(_Result, "Result");
   var Result = _Result;
@@ -999,6 +1042,11 @@ var SapphireResult = (function (exports) {
     return Result.isResult(value) ? value : ok(value);
   }
   __name(resolve, "resolve");
+  async function* unwrapSafeAsync(result) {
+    const _result = await result;
+    return yield* _result.unwrapSafe();
+  }
+  __name(unwrapSafeAsync, "unwrapSafeAsync");
 
   // src/lib/Option.ts
   var ValueProperty2 = Symbol.for("@sapphire/result:Option.value");