urldsl.language.FragmentImpl.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of url-dsl_3.0.0-RC3 Show documentation

A tiny library for parsing and creating urls in a type-safe way

The newest version!

package urldsl.language

import urldsl.errors.FragmentMatchingError
import urldsl.vocabulary.{FromString, Printer}

import scala.reflect.ClassTag
import scala.language.implicitConversions

/**
  * This is the analogue of [[PathSegmentImpl]] for the [[Fragment]] trait. It "pre-applies" the error type based on the
  * provided [[FragmentMatchingError]].
  *
  * @tparam E type of the "pre-applied" errors
  */
trait FragmentImpl[E] {

  /** implementation of [[FragmentMatchingError]] for generating relevant matching errors. */
  implicit protected val fragmentError: FragmentMatchingError[E]

  /**
    * Returns a [[Fragment]] matching an element of type T.
    * If the fragment is missing, it fails with a missing fragment error.
    */
  final def fragment[T](implicit fromString: FromString[T, E], printer: Printer[T]): Fragment[T, E] =
    Fragment.fragment[T, E]

  /**
    * Returns a [[Fragment]] matching an element of type T.
    * If the fragment is missing, it succeeds with None.
    */
  final def maybeFragment[T](implicit fromString: FromString[T, E], printer: Printer[T]): Fragment[Option[T], E] =
    Fragment.maybeFragment[T, E]

  /**
    * Returns a [[Fragment]] imposing that the URL does not contain any fragment.
    *
    * Note that a URL ending with "#" is considered having no fragment.
    */
  final def emptyFragment: Fragment[Unit, E] = Fragment.empty

  implicit final def asFragment[T](t: T)(
      implicit fromString: FromString[T, E],
      printer: Printer[T],
      classTag: ClassTag[T]
  ): Fragment[Unit, E] = Fragment.asFragment(t)

}

object FragmentImpl {

  /** Summoner for a [[FragmentImpl]] instance, given the [[FragmentMatchingError]] error. */
  def apply[E](implicit error: FragmentMatchingError[E]): FragmentImpl[E] = new FragmentImpl[E] {
    implicit protected val fragmentError: FragmentMatchingError[E] = error
  }
}