Rename SuccessOrFailure to Result and hide Failure from ABI

* The members of Result are isSuccess, isFailure, exceptionOrNull, getOrNull
* The rest of API is implemented via inline-only extensions
* There are two internal functions to hide detailed mechanics of an internal
  Result.Failure class: createFailure and throwOnFailure
* Result.toString is explicit: either Success(v) or Failure(x)

See KT-26538

idea/testData/inspectionsLocal/coroutines/redundantRunCatching/simple.kt

@@ -2,10 +2,10 @@
 
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <T> runCatching(block: () -> T) = SuccessOrFailure(block())
+fun <T> runCatching(block: () -> T) = Result(block())
 
 fun correct(arg: Boolean) = runCatching<caret> { if (arg) throw AssertionError("") else 12 }.getOrThrow()

idea/testData/inspectionsLocal/coroutines/redundantRunCatching/simple.kt.after

@@ -2,10 +2,10 @@
 
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <T> runCatching(block: () -> T) = SuccessOrFailure(block())
+fun <T> runCatching(block: () -> T) = Result(block())
 
 fun correct(arg: Boolean) = run { if (arg) throw AssertionError("") else 12 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/.inspection

@@ -1 +1 @@
-org.jetbrains.kotlin.idea.inspections.coroutines.ResultIsSuccessOrFailureInspection
+org.jetbrains.kotlin.idea.inspections.coroutines.ResultIsResultInspection

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/abstract.kt

@@ -1,10 +1,10 @@
-// FIX: Unwrap 'SuccessOrFailure' return type (breaks use-sites!)
+// FIX: Unwrap 'Result' return type (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 abstract class Abstract {
-    abstract fun <caret>foo(): SuccessOrFailure<Int>
+    abstract fun <caret>foo(): Result<Int>
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/abstract.kt.after

@@ -1,7 +1,7 @@
-// FIX: Unwrap 'SuccessOrFailure' return type (breaks use-sites!)
+// FIX: Unwrap 'Result' return type (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/anonymous.kt

@@ -1,9 +1,9 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test() {
-    val x = <caret>fun() = SuccessOrFailure("123")
+    val x = <caret>fun() = Result("123")
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/anonymous.kt.after

@@ -1,9 +1,9 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test() {
-    val x = fun() = SuccessOrFailure("123").getOrThrow()
+    val x = fun() = Result("123").getOrThrow()
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/complexBlock.kt

@@ -3,28 +3,28 @@
 
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <caret>incorrectBlock(arg: Boolean, arg2: Boolean?): SuccessOrFailure<Int> {
+fun <caret>incorrectBlock(arg: Boolean, arg2: Boolean?): Result<Int> {
     if (arg) {
         class Local {
-            fun foo(): SuccessOrFailure<String> {
-                return SuccessOrFailure("NO")
+            fun foo(): Result<String> {
+                return Result("NO")
             }
         }
-        return SuccessOrFailure(1)
+        return Result(1)
     } else {
         when (arg2) {
             true -> {
-                val x = fun(): SuccessOrFailure<Boolean> {
-                    return SuccessOrFailure(false)
+                val x = fun(): Result<Boolean> {
+                    return Result(false)
                 }
                 if (x().getOrThrow()) {
-                    return SuccessOrFailure(2)
+                    return Result(2)
                 } else {
-                    return SuccessOrFailure(0)
+                    return Result(0)
                 }
             }
             else -> {
@@ -32,9 +32,9 @@ fun <caret>incorrectBlock(arg: Boolean, arg2: Boolean?): SuccessOrFailure<Int> {
                     listOf(1, 2, 3).forEach {
                         if (it == 2) return@forEach
                     }
-                    return SuccessOrFailure(3)
+                    return Result(3)
                 }
-                return SuccessOrFailure(4)
+                return Result(4)
             }
         }
     }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/complexBlock.kt.after

@@ -3,28 +3,28 @@
 
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun incorrectBlock(arg: Boolean, arg2: Boolean?): Int {
     if (arg) {
         class Local {
-            fun foo(): SuccessOrFailure<String> {
-                return SuccessOrFailure("NO")
+            fun foo(): Result<String> {
+                return Result("NO")
             }
         }
-        return SuccessOrFailure(1).getOrThrow()
+        return Result(1).getOrThrow()
     } else {
         when (arg2) {
             true -> {
-                val x = fun(): SuccessOrFailure<Boolean> {
-                    return SuccessOrFailure(false)
+                val x = fun(): Result<Boolean> {
+                    return Result(false)
                 }
                 if (x().getOrThrow()) {
-                    return SuccessOrFailure(2).getOrThrow()
+                    return Result(2).getOrThrow()
                 } else {
-                    return SuccessOrFailure(0).getOrThrow()
+                    return Result(0).getOrThrow()
                 }
             }
             else -> {
@@ -32,9 +32,9 @@ fun incorrectBlock(arg: Boolean, arg2: Boolean?): Int {
                     listOf(1, 2, 3).forEach {
                         if (it == 2) return@forEach
                     }
-                    return SuccessOrFailure(3).getOrThrow()
+                    return Result(3).getOrThrow()
                 }
-                return SuccessOrFailure(4).getOrThrow()
+                return Result(4).getOrThrow()
             }
         }
     }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/lambdaSimple.kt

@@ -1,9 +1,9 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test() {
-    val x = <caret>{ SuccessOrFailure(true) }
+    val x = <caret>{ Result(true) }
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/lambdaSimple.kt.after

@@ -1,9 +1,9 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test() {
-    val x = { SuccessOrFailure(true).getOrThrow() }
+    val x = { Result(true).getOrThrow() }
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/lambdaWithPartialReturn.kt

@@ -1,15 +1,15 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test(arg: Boolean) {
     val x = foo@<caret>{
         if (!arg) {
-            return@foo SuccessOrFailure(true)
+            return@foo Result(true)
         } else {
-            SuccessOrFailure(false)
+            Result(false)
         }
     }
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/lambdaWithPartialReturn.kt.after

@@ -1,15 +1,15 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test(arg: Boolean) {
     val x = foo@{
         (if (!arg) {
-            return@foo SuccessOrFailure(true).getOrThrow()
+            return@foo Result(true).getOrThrow()
         } else {
-            SuccessOrFailure(false)
+            Result(false)
         }).getOrThrow()
     }
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/lambdaWithReturn.kt

@@ -1,9 +1,9 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test() {
-    val x = foo@<caret>{ return@foo SuccessOrFailure(true) }
+    val x = foo@<caret>{ return@foo Result(true) }
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/lambdaWithReturn.kt.after

@@ -1,9 +1,9 @@
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun test() {
-    val x = foo@<caret>{ return@foo SuccessOrFailure(true).getOrThrow() }
+    val x = foo@<caret>{ return@foo Result(true).getOrThrow() }
 }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/needParentheses.kt

@@ -1,10 +1,10 @@
 // FIX: Add '.getOrThrow()' to function result (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 
-    operator fun plus(other: SuccessOrFailure<T>) = other
+    operator fun plus(other: Result<T>) = other
 }
 
-fun <caret>incorrect() = SuccessOrFailure("123") + SuccessOrFailure("456")
+fun <caret>incorrect() = Result("123") + Result("456")

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/needParentheses.kt.after

@@ -1,10 +1,10 @@
 // FIX: Add '.getOrThrow()' to function result (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 
-    operator fun plus(other: SuccessOrFailure<T>) = other
+    operator fun plus(other: Result<T>) = other
 }
 
-fun incorrect() = (SuccessOrFailure("123") + SuccessOrFailure("456")).getOrThrow()
+fun incorrect() = (Result("123") + Result("456")).getOrThrow()

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/rename.kt

@@ -1,8 +1,8 @@
 // FIX: Rename to 'incorrectCatching'
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <caret>incorrect() = SuccessOrFailure("123")
+fun <caret>incorrect() = Result("123")

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/rename.kt.after

@@ -1,8 +1,8 @@
 // FIX: Rename to 'incorrectCatching'
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <caret>incorrectCatching() = SuccessOrFailure("123")
+fun <caret>incorrectCatching() = Result("123")

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/simple.kt

@@ -1,8 +1,8 @@
 // FIX: Add '.getOrThrow()' to function result (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <caret>incorrect() = SuccessOrFailure("123")
+fun <caret>incorrect() = Result("123")

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/simple.kt.after

@@ -1,8 +1,8 @@
 // FIX: Add '.getOrThrow()' to function result (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun incorrect() = SuccessOrFailure("123").getOrThrow()
+fun incorrect() = Result("123").getOrThrow()

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/simpleBlock.kt

@@ -1,21 +1,21 @@
 // FIX: Add '.getOrThrow()' to function result (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
-fun <caret>incorrectBlock(arg: Boolean, arg2: Boolean?): SuccessOrFailure<Int> {
+fun <caret>incorrectBlock(arg: Boolean, arg2: Boolean?): Result<Int> {
     if (arg) {
-        return SuccessOrFailure(1)
+        return Result(1)
     } else {
         when (arg2) {
-            true -> return SuccessOrFailure(2)
+            true -> return Result(2)
             else -> {
                 if (arg2 == false) {
-                    return SuccessOrFailure(3)
+                    return Result(3)
                 }
-                return SuccessOrFailure(4)
+                return Result(4)
             }
         }
     }

idea/testData/inspectionsLocal/coroutines/resultIsSuccessOrFailure/simpleBlock.kt.after

@@ -1,21 +1,21 @@
 // FIX: Add '.getOrThrow()' to function result (breaks use-sites!)
 package kotlin
 
-class SuccessOrFailure<T>(val value: T?) {
+class Result<T>(val value: T?) {
     fun getOrThrow(): T = value ?: throw AssertionError("")
 }
 
 fun incorrectBlock(arg: Boolean, arg2: Boolean?): Int {
     if (arg) {
-        return SuccessOrFailure(1).getOrThrow()
+        return Result(1).getOrThrow()
     } else {
         when (arg2) {
-            true -> return SuccessOrFailure(2).getOrThrow()
+            true -> return Result(2).getOrThrow()
             else -> {
                 if (arg2 == false) {
-                    return SuccessOrFailure(3).getOrThrow()
+                    return Result(3).getOrThrow()
                 }
-                return SuccessOrFailure(4).getOrThrow()
+                return Result(4).getOrThrow()
             }
         }
     }