doobie.enumerated.columnnullable.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doobie-core_3 Show documentation

Pure functional JDBC layer for Scala.

There is a newer version: 1.0.0-RC6

// Copyright (c) 2013-2020 Rob Norris and Contributors
// This software is licensed under the MIT License (MIT).
// For more information see LICENSE or https://opensource.org/licenses/MIT

package doobie.enumerated

import doobie.util.invariant.*

import java.sql.ResultSetMetaData.*

import cats.ApplicativeError
import cats.kernel.Eq
import cats.kernel.instances.int.*

/** @group Types */
sealed abstract class ColumnNullable(val toInt: Int) extends Product with Serializable {
  def toNullability: Nullability =
    Nullability.fromColumnNullable(this)
}

/** @group Modules */
object ColumnNullable {

  /** @group Values */
  case object NoNulls extends ColumnNullable(columnNoNulls)

  /** @group Values */
  case object Nullable extends ColumnNullable(columnNullable)

  /** @group Values */
  case object NullableUnknown extends ColumnNullable(columnNullableUnknown)

  def fromInt(n: Int): Option[ColumnNullable] =
    Some(n) collect {
      case NoNulls.toInt         => NoNulls
      case Nullable.toInt        => Nullable
      case NullableUnknown.toInt => NullableUnknown
    }

  def fromNullability(n: Nullability): ColumnNullable =
    n match {
      case Nullability.NoNulls         => NoNulls
      case Nullability.Nullable        => Nullable
      case Nullability.NullableUnknown => NullableUnknown
    }

  def fromIntF[F[_]](n: Int)(implicit AE: ApplicativeError[F, Throwable]): F[ColumnNullable] =
    ApplicativeError.liftFromOption(fromInt(n), InvalidOrdinal[ColumnNullable](n))

  implicit val EqColumnNullable: Eq[ColumnNullable] =
    Eq.by(_.toInt)

}