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

package/dist/cjs/index.cjs

@@ -41,6 +41,7 @@ var ResultError = _ResultError;
 // 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) {
@@ -467,6 +468,7 @@ var _Result = class _Result {
    * @seealso {@link unwrapOrElse}
    * @seealso {@link unwrapErr}
    * @seealso {@link unwrapRaw}
+   * @seealso {@link unwrapSafe}
    *
    * @example
    * ```typescript
@@ -497,6 +499,7 @@ var _Result = class _Result {
    * @seealso {@link unwrapOr}
    * @seealso {@link unwrapOrElse}
    * @seealso {@link unwrapRaw}
+   * @seealso {@link unwrapSafe}
    *
    * @example
    * ```typescript
@@ -528,6 +531,7 @@ var _Result = class _Result {
    * @seealso {@link unwrapOrElse}
    * @seealso {@link unwrapErr}
    * @seealso {@link unwrapRaw}
+   * @seealso {@link unwrapSafe}
    *
    * @param defaultValue The default value.
    *
@@ -553,6 +557,7 @@ var _Result = class _Result {
    * @seealso {@link unwrapOr}
    * @seealso {@link unwrapErr}
    * @seealso {@link unwrapRaw}
+   * @seealso {@link unwrapSafe}
    *
    * @param op The predicate.
    *
@@ -577,6 +582,7 @@ var _Result = class _Result {
    * @seealso {@link unwrapOr}
    * @seealso {@link unwrapOrElse}
    * @seealso {@link unwrapErr}
+   * @seealso {@link unwrapSafe}
    *
    * @example
    * ```typescript
@@ -597,6 +603,26 @@ var _Result = class _Result {
     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.
@@ -871,6 +897,16 @@ var _Result = class _Result {
   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);
@@ -990,6 +1026,13 @@ var _Result = class _Result {
     }
     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;
@@ -998,6 +1041,11 @@ function resolve(value) {
   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");