Packages

abstract class PathMatcher[L] extends (Path) => Matching[L]

A PathMatcher tries to match a prefix of a given string and returns either a PathMatcher.Matched instance if matched, otherwise PathMatcher.Unmatched.

Self Type
PathMatcher[L]
Source
PathMatcher.scala
Linear Supertypes
(Path) => Matching[L], AnyRef, Any
Known Subclasses
HexIntNumber, HexLongNumber, IntNumber, LongNumber, NumberMatcher, PathEnd, Remaining, RemainingPath, Segment, Slash
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PathMatcher
  2. Function1
  3. AnyRef
  4. Any
Implicitly
  1. by EnhancedPathMatcher
  2. by PathMatcher1Ops
  3. by EnhancedPathMatcher
  4. by PathMatcher1Ops
  5. by any2stringadd
  6. by StringFormat
  7. by Ensuring
  8. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PathMatcher()(implicit ev: Tuple[L])

Abstract Value Members

  1. abstract def apply(v1: Path): Matching[L]
    Definition Classes
    Function1

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toany2stringadd[PathMatcher[L]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PathMatcher[L], B)
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toArrowAssoc[PathMatcher[L]] performed by method ArrowAssoc in scala.Predef.This conversion will take place only if L is (Nothing) (L =:= (Nothing)).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def /[R](other: PathMatcher[R])(implicit join: Join[L, R]): PathMatcher[Out]

    Alias for slash.

  6. def /: PathMatcher[L]

    Alias for slash.

  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def andThen[A](g: (Matching[L]) => A): (Path) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  9. def append[R](other: PathMatcher[R])(implicit join: Join[L, R]): PathMatcher[Out]
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def compose[A](g: (A) => Path): (A) => Matching[L]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. def ensuring(cond: (PathMatcher[L]) => Boolean, msg: => Any): PathMatcher[L]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnsuring[PathMatcher[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (PathMatcher[L]) => Boolean): PathMatcher[L]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnsuring[PathMatcher[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): PathMatcher[L]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnsuring[PathMatcher[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): PathMatcher[L]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnsuring[PathMatcher[L]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. implicit val ev: Tuple[L]
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. def flatMap[R](f: (T) => Option[R]): PathMatcher1[R]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toPathMatcher1Ops[T] performed by method PathMatcher1Ops in org.apache.pekko.http.scaladsl.server.PathMatcher.This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    PathMatcher1Ops
  22. def flatMap[R](f: (T) => Option[R]): PathMatcher1[R]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toPathMatcher1Ops[T] performed by method PathMatcher1Ops in org.apache.pekko.http.scaladsl.server.PathMatcher.This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    PathMatcher1Ops
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def map[R](f: (T) => R): PathMatcher1[R]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toPathMatcher1Ops[T] performed by method PathMatcher1Ops in org.apache.pekko.http.scaladsl.server.PathMatcher.This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    PathMatcher1Ops
  27. def map[R](f: (T) => R): PathMatcher1[R]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toPathMatcher1Ops[T] performed by method PathMatcher1Ops in org.apache.pekko.http.scaladsl.server.PathMatcher.This conversion will take place only if L is (T) (L =:= (T)).
    Definition Classes
    PathMatcher1Ops
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def or[R >: L](other: PathMatcher[_ <: R])(implicit arg0: Tuple[R]): PathMatcher[R]
  32. def repeat(min: Int, max: Int, separator: PathMatcher0 = PathMatchers.Neutral)(implicit lift: Lift[L, List]): PathMatcher[Out]

    Turns this PathMatcher into one that matches a number of times (with the given separator) and potentially extracts a List of the underlying matcher's extractions.

    Turns this PathMatcher into one that matches a number of times (with the given separator) and potentially extracts a List of the underlying matcher's extractions. If less than min applications of the underlying matcher have succeeded the produced matcher fails, otherwise it matches up to the given max number of applications. Note that it won't fail even if more than max applications could succeed! The "surplus" path elements will simply be left unmatched.

    The result type depends on the type of the underlying matcher:

    If a `matcher` is of typethen `matcher.repeat(...)` is of type
    `PathMatcher0``PathMatcher0`
    `PathMatcher1[T]``PathMatcher1[List[T]`
    `PathMatcher[L :Tuple]``PathMatcher[List[L]]`

  33. def repeat(count: Int, separator: PathMatcher0)(implicit lift: Lift[L, List]): PathMatcher[Out]

    Same as repeat(min = count, max = count, separator = separator).

  34. def repeat(count: Int)(implicit lift: Lift[L, List]): PathMatcher[Out]

    Same as repeat(min = count, max = count).

  35. def slash[R](other: PathMatcher[R])(implicit join: Join[L, R]): PathMatcher[Out]
  36. def slash: PathMatcher[L]
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def tflatMap[R](f: (L) => Option[R])(implicit arg0: Tuple[R]): PathMatcher[R]
  39. def tmap[R](f: (L) => R)(implicit arg0: Tuple[R]): PathMatcher[R]
  40. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  41. def transform[R](f: (Matching[L]) => Matching[R])(implicit arg0: Tuple[R]): PathMatcher[R]
  42. def unary_!: PathMatcher0

    Operator alternative to PathMatchers.not

  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. def |[R >: L](other: PathMatcher[_ <: R])(implicit arg0: Tuple[R]): PathMatcher[R]

    Alias for or.

  47. def ~[R](other: PathMatcher[R])(implicit join: Join[L, R]): PathMatcher[Out]

    Alias for append.

Shadowed Implicit Value Members

  1. def ?(implicit lift: Lift[L, Option]): PathMatcher[Out]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnhancedPathMatcher[L] performed by method EnhancedPathMatcher in org.apache.pekko.http.scaladsl.server.PathMatcher.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (pathMatcher: EnhancedPathMatcher[L]).?(lift)
    Definition Classes
    EnhancedPathMatcher
  2. def ?(implicit lift: Lift[L, Option]): PathMatcher[Out]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnhancedPathMatcher[L] performed by method EnhancedPathMatcher in org.apache.pekko.http.scaladsl.server.PathMatcher.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (pathMatcher: EnhancedPathMatcher[L]).?(lift)
    Definition Classes
    EnhancedPathMatcher
  3. def optional(implicit lift: Lift[L, Option]): PathMatcher[Out]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnhancedPathMatcher[L] performed by method EnhancedPathMatcher in org.apache.pekko.http.scaladsl.server.PathMatcher.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (pathMatcher: EnhancedPathMatcher[L]).optional(lift)
    Definition Classes
    EnhancedPathMatcher
  4. def optional(implicit lift: Lift[L, Option]): PathMatcher[Out]
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toEnhancedPathMatcher[L] performed by method EnhancedPathMatcher in org.apache.pekko.http.scaladsl.server.PathMatcher.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (pathMatcher: EnhancedPathMatcher[L]).optional(lift)
    Definition Classes
    EnhancedPathMatcher

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toStringFormat[PathMatcher[L]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (PathMatcher[L], B)
    Implicit
    This member is added by an implicit conversion from PathMatcher[L] toArrowAssoc[PathMatcher[L]] performed by method ArrowAssoc in scala.Predef.This conversion will take place only if L is (Nothing) (L =:= (Nothing)).
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from (Path) => Matching[L]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion EnhancedPathMatcher fromPathMatcher[L] to EnhancedPathMatcher[L]

Inherited by implicit conversion PathMatcher1Ops fromPathMatcher[L] to PathMatcher1Ops[T]

Inherited by implicit conversion EnhancedPathMatcher fromPathMatcher[L] to EnhancedPathMatcher[L]

Inherited by implicit conversion PathMatcher1Ops fromPathMatcher[L] to PathMatcher1Ops[T]

Inherited by implicit conversion any2stringadd fromPathMatcher[L] to any2stringadd[PathMatcher[L]]

Inherited by implicit conversion StringFormat fromPathMatcher[L] to StringFormat[PathMatcher[L]]

Inherited by implicit conversion Ensuring fromPathMatcher[L] to Ensuring[PathMatcher[L]]

Inherited by implicit conversion ArrowAssoc fromPathMatcher[L] to ArrowAssoc[PathMatcher[L]]

Ungrouped