scaloi.syntax.CobindOps.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scaloi_2.13 Show documentation

Fyne thyngges from Learning Objects, an LO Venture

The newest version!

/*
 * Copyright 2007 Learning Objects
 *
 * 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 scaloi.syntax

import scalaz.Cobind

import scala.annotation.nowarn

/**
  * Enhancements on cobinds.
  *
  * @param self the cobind
  * @tparam F the cobind type
  * @tparam A the cobound type
  */
final class CobindOps[F[_], A](private val self: F[A]) extends AnyVal {
  /** Apply [self] to a side-effecting function, if applicable, discarding any result.
    *
    * @param f the side-effecting function
    * @param F cobind evidence
    * @tparam B the discarded result type
    */
  @inline
  final def coflatForeach[B](f: F[A] => B)(implicit F: Cobind[F]): Unit =
    F.cobind(self)(f)
}

/**
  * Implicit conversion for cobind operations.
  */
trait ToCobindOps {
  import language.implicitConversions

  /**
    * Implicit conversion from cobind to the cobind enhancements.
    * @param f the cobind
    * @tparam F the cobind type
    * @tparam A the cobound type
    */
  @inline
  @nowarn("cat=unused")
  implicit final def toCobindOps[F[_] : Cobind, A](f: F[A]): CobindOps[F, A] = new CobindOps(f)
}