io.github.zeal18.zio.mongodb.driver.model.CollationAlternate.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zio-mongodb-driver_3 Show documentation

zio-mongodb-driver

There is a newer version: 0.11.1

package io.github.zeal18.zio.mongodb.driver.model

import com.mongodb.client.model.CollationAlternate as JCollactionAlternate

/** Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.
  *
  * @mongodb.server.release 3.4
  */
sealed trait CollationAlternate {
  private[driver] def toJava: JCollactionAlternate =
    this match {
      case CollationAlternate.Shifted      => JCollactionAlternate.SHIFTED
      case CollationAlternate.NonIgnorable => JCollactionAlternate.NON_IGNORABLE
    }
}

object CollationAlternate {

  /** Shifted
    *
    * Spaces and punctuation are not considered base characters, and are only distinguished when the collation strength is > 3
    * @see CollationMaxVariable
    */
  case object Shifted extends CollationAlternate

  /** Non-ignorable
    *
    * Spaces and punctuation are considered base characters
    */
  case object NonIgnorable extends CollationAlternate
}