packages/SystemUI/src/com/android/systemui/common/coroutine/ChannelExt.kt

/*
 *  Copyright (C) 2022 The Android Open Source Project
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */

package com.android.systemui.common.coroutine

import android.util.Log
import kotlinx.coroutines.channels.SendChannel
import kotlinx.coroutines.channels.onFailure

object ChannelExt {

    /**
     * Convenience wrapper around [SendChannel.trySend] that also logs on failure. This is the
     * equivalent of calling:
     * ```
     * sendChannel.trySend(element).onFailure {
     *     Log.e(
     *         loggingTag,
     *         "Failed to send $elementDescription" +
     *             " - downstream canceled or failed.",
     *          it,
     *    )
     * }
     * ```
     */
    fun <T> SendChannel<T>.trySendWithFailureLogging(
        element: T,
        loggingTag: String,
        elementDescription: String = "updated state",
    ) {
        trySend(element).onFailure {
            Log.e(
                loggingTag,
                "Failed to send $elementDescription - downstream canceled or failed.",
                it,
            )
        }
    }
}