-
Notifications
You must be signed in to change notification settings - Fork 155
/
string.scala
91 lines (73 loc) · 2.81 KB
/
string.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
package eu.timepit.refined.types
import eu.timepit.refined.api.{Refined, RefinedType, RefinedTypeOps}
import eu.timepit.refined.collection.{MaxSize, NonEmpty}
import eu.timepit.refined.string.{HexStringSpec, Trimmed}
import shapeless.Witness
/** Module for `String` refined types. */
object string {
/** A `String` with length less than or equal to `N`. */
type FiniteString[N] = String Refined MaxSize[N]
object FiniteString {
class FiniteStringOps[N <: Int](
implicit
rt: RefinedType.AuxT[FiniteString[N], String],
wn: Witness.Aux[N]
) extends RefinedTypeOps[FiniteString[N], String] {
/** The maximum length of a `FiniteString[N]`. */
final val maxLength: N = wn.value
/**
* Creates a `FiniteString[N]` from `t` by truncating it
* if it is longer than `N`.
*
* Example: {{{
* scala> import eu.timepit.refined.W
* | import eu.timepit.refined.types.string.FiniteString
*
* scala> FiniteString[W.`3`.T].truncate("abcde")
* res1: FiniteString[W.`3`.T] = abc
* }}}
*/
def truncate(t: String): FiniteString[N] =
Refined.unsafeApply(t.substring(0, math.min(t.length, maxLength)))
}
/**
* Creates a "companion object" for `FiniteString[N]` with a fixed `N`.
*
* Example: {{{
* scala> import eu.timepit.refined.W
* | import eu.timepit.refined.types.string.FiniteString
*
* scala> val FString4 = FiniteString[W.`4`.T]
* scala> FString4.from("abcd")
* res1: Either[String, FiniteString[W.`4`.T]] = Right(abcd)
* }}}
*/
def apply[N <: Int](
implicit
rt: RefinedType.AuxT[FiniteString[N], String],
wn: Witness.Aux[N]
): FiniteStringOps[N] = new FiniteStringOps[N]
}
/** A `String` that is not empty. */
type NonEmptyString = String Refined NonEmpty
object NonEmptyString extends RefinedTypeOps[NonEmptyString, String]
/** A `String` that contains no leading or trailing whitespace. */
type TrimmedString = String Refined Trimmed
object TrimmedString extends RefinedTypeOps[TrimmedString, String] {
/** Creates a `TrimmedString` from `s` by trimming it. */
def trim(s: String): TrimmedString = Refined.unsafeApply(s.trim)
}
/** A `String` representing a hexadecimal number. */
type HexString = String Refined HexStringSpec
object HexString extends RefinedTypeOps[HexString, String]
}
trait StringTypes {
final type FiniteString[N] = string.FiniteString[N]
final val FiniteString = string.FiniteString
final type NonEmptyString = string.NonEmptyString
final val NonEmptyString = string.NonEmptyString
final type TrimmedString = string.TrimmedString
final val TrimmedString = string.TrimmedString
final type HexString = string.HexString
final val HexString = string.HexString
}