(Ljava/lang/Object;)V
83 | public final fun component1 ()Ljava/lang/Object;
84 | public final fun copy (Ljava/lang/Object;)Lio/getstream/result/Result$Success;
85 | public static synthetic fun copy$default (Lio/getstream/result/Result$Success;Ljava/lang/Object;ILjava/lang/Object;)Lio/getstream/result/Result$Success;
86 | public fun equals (Ljava/lang/Object;)Z
87 | public final fun getValue ()Ljava/lang/Object;
88 | public fun hashCode ()I
89 | public fun toString ()Ljava/lang/String;
90 | }
91 |
92 | public final class io/getstream/result/ResultKt {
93 | public static final fun flatMap (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function1;)Lio/getstream/result/Result;
94 | public static final synthetic fun flatMapSuspend (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
95 | public static final synthetic fun onErrorSuspend (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
96 | public static final synthetic fun onSuccessSuspend (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
97 | public static final synthetic fun recover (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function1;)Lio/getstream/result/Result$Success;
98 | public static final synthetic fun recoverSuspend (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function2;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
99 | public static final synthetic fun then (Lio/getstream/result/Result;Lkotlin/jvm/functions/Function1;)Lio/getstream/result/Result;
100 | }
101 |
102 | public abstract interface annotation class io/getstream/result/internal/StreamHandsOff : java/lang/annotation/Annotation {
103 | public abstract fun reason ()Ljava/lang/String;
104 | }
105 |
106 |
--------------------------------------------------------------------------------
/stream-result/build.gradle.kts:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2014-2023 Stream.io Inc. All rights reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | @file:Suppress("UnstableApiUsage")
17 |
18 | import io.getstream.Configurations
19 |
20 | @Suppress("DSL_SCOPE_VIOLATION")
21 | plugins {
22 | id(libs.plugins.android.library.get().pluginId)
23 | id(libs.plugins.kotlin.multiplatform.get().pluginId)
24 | id(libs.plugins.nexus.plugin.get().pluginId)
25 | }
26 |
27 | mavenPublishing {
28 | val artifactId = "stream-result"
29 | coordinates(
30 | Configurations.artifactGroup,
31 | artifactId,
32 | Configurations.versionName
33 | )
34 |
35 | pom {
36 | name.set(artifactId)
37 | description.set("Railway-oriented library to easily model and handle success/failure for Kotlin, Android, and Retrofit.")
38 | }
39 | }
40 |
41 | kotlin {
42 | androidTarget { publishLibraryVariants("release") }
43 | jvm()
44 |
45 | iosX64()
46 | iosArm64()
47 | iosSimulatorArm64()
48 |
49 | macosX64()
50 | macosArm64()
51 |
52 | @Suppress("OPT_IN_USAGE")
53 | applyHierarchyTemplate {
54 | common {
55 | group("android") {
56 | withAndroidTarget()
57 | }
58 | group("jvm") {
59 | withJvm()
60 | }
61 | group("skia") {
62 | withJvm()
63 | group("apple") {
64 | group("ios") {
65 | withIosX64()
66 | withIosArm64()
67 | withIosSimulatorArm64()
68 | }
69 | group("macos") {
70 | withMacosX64()
71 | withMacosArm64()
72 | }
73 | }
74 | }
75 | }
76 | }
77 |
78 | sourceSets {
79 | all {
80 | languageSettings.optIn("kotlin.contracts.ExperimentalContracts")
81 | }
82 | }
83 |
84 | explicitApi()
85 | }
86 |
87 | android {
88 | compileSdk = Configurations.compileSdk
89 | namespace = "io.getstream.result"
90 | defaultConfig {
91 | minSdk = Configurations.minSdk
92 | consumerProguardFiles("consumer-proguard-rules.pro")
93 | }
94 |
95 | compileOptions {
96 | sourceCompatibility = JavaVersion.VERSION_17
97 | targetCompatibility = JavaVersion.VERSION_17
98 | }
99 | }
100 |
101 | dependencies {
102 | }
--------------------------------------------------------------------------------
/stream-result/src/commonMain/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
17 |
--------------------------------------------------------------------------------
/stream-result/src/commonMain/kotlin/io/getstream/result/Error.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2014-2022 Stream.io Inc. All rights reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package io.getstream.result
17 |
18 | import io.getstream.result.Error.NetworkError.Companion.UNKNOWN_STATUS_CODE
19 | import io.getstream.result.internal.StreamHandsOff
20 |
21 | /**
22 | * Represents the generic error model.
23 | */
24 | public sealed class Error {
25 |
26 | public abstract val message: String
27 |
28 | /**
29 | * An error that only contains the message.
30 | *
31 | * @param message The message describing the error.
32 | */
33 | public data class GenericError(override val message: String) : Error()
34 |
35 | /**
36 | * An error that contains a message and cause.
37 | *
38 | * @param message The message describing the error.
39 | * @param cause The [Throwable] associated with the error.
40 | */
41 | public data class ThrowableError(override val message: String, public val cause: Throwable) :
42 | Error() {
43 |
44 | @StreamHandsOff(
45 | "Throwable doesn't override the equals method;" +
46 | " therefore, it needs custom implementation."
47 | )
48 | override fun equals(other: Any?): Boolean {
49 | if (this === other) return true
50 | if (other != null && this::class != other::class) return false
51 |
52 | return (other as? Error)?.let {
53 | message == it.message && cause.equalCause(it.extractCause())
54 | } ?: false
55 | }
56 |
57 | private fun Throwable?.equalCause(other: Throwable?): Boolean {
58 | if ((this == null && other == null) || this === other) return true
59 | return this?.message == other?.message && this?.cause.equalCause(other?.cause)
60 | }
61 |
62 | @StreamHandsOff(
63 | "Throwable doesn't override the hashCode method;" +
64 | " therefore, it needs custom implementation."
65 | )
66 | override fun hashCode(): Int {
67 | return 31 * message.hashCode() + cause.hashCode()
68 | }
69 | }
70 |
71 | /**
72 | * An error resulting from the network operation.
73 | *
74 | * @param message The message describing the error.
75 | * @param serverErrorCode The error code returned by the backend.
76 | * @param statusCode HTTP status code or [UNKNOWN_STATUS_CODE] if not available.
77 | * @param cause The optional [Throwable] associated with the error.
78 | */
79 | public data class NetworkError(
80 | override val message: String,
81 | public val serverErrorCode: Int,
82 | public val statusCode: Int = UNKNOWN_STATUS_CODE,
83 | public val cause: Throwable? = null
84 | ) : Error() {
85 |
86 | @StreamHandsOff(
87 | "Throwable doesn't override the equals method;" +
88 | " therefore, it needs custom implementation."
89 | )
90 | override fun equals(other: Any?): Boolean {
91 | if (this === other) return true
92 | if (other != null && this::class != other::class) return false
93 |
94 | return (other as? Error)?.let {
95 | message == it.message && cause.equalCause(it.extractCause())
96 | } ?: false
97 | }
98 |
99 | private fun Throwable?.equalCause(other: Throwable?): Boolean {
100 | if ((this == null && other == null) || this === other) return true
101 | return this?.message == other?.message && this?.cause.equalCause(other?.cause)
102 | }
103 |
104 | @StreamHandsOff(
105 | "Throwable doesn't override the hashCode method;" +
106 | " therefore, it needs custom implementation."
107 | )
108 | override fun hashCode(): Int {
109 | return 31 * message.hashCode() + (cause?.hashCode() ?: 0)
110 | }
111 |
112 | public companion object {
113 | public const val UNKNOWN_STATUS_CODE: Int = -1
114 | }
115 | }
116 | }
117 |
118 | /**
119 | * Copies the original [Error] objects with custom message.
120 | *
121 | * @param message The message to replace.
122 | *
123 | * @return New [Error] instance.
124 | */
125 | public fun Error.copyWithMessage(message: String): Error {
126 | return when (this) {
127 | is Error.GenericError -> this.copy(message = message)
128 | is Error.NetworkError -> this.copy(message = message)
129 | is Error.ThrowableError -> this.copy(message = message)
130 | }
131 | }
132 |
133 | /**
134 | * Extracts the cause from [Error] object or null if it's not available.
135 | *
136 | * @return The [Throwable] that is the error's cause or null if not available.
137 | */
138 | public fun Error.extractCause(): Throwable? {
139 | return when (this) {
140 | is Error.GenericError -> null
141 | is Error.NetworkError -> cause
142 | is Error.ThrowableError -> cause
143 | }
144 | }
145 |
--------------------------------------------------------------------------------
/stream-result/src/commonMain/kotlin/io/getstream/result/internal/StreamHandsOff.kt:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2014-2023 Stream.io Inc. All rights reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 | package io.getstream.result.internal
17 |
18 | /**
19 | * Indicates that the annotated code should not be modified without consulting the team.
20 | * @param reason
21 | * For example:
22 | *
23 | *
24 | * @StreamHandsOff(reason = "If you move a card, the house is collapsed")
25 | * public class HouseOfCards { }
26 | *
27 | */
28 | @MustBeDocumented
29 | @Retention(AnnotationRetention.RUNTIME)
30 | public annotation class StreamHandsOff(val reason: String)
31 |
--------------------------------------------------------------------------------