PathPattern

io.eezo.http.PathPattern
See thePathPattern companion object
final class PathPattern

A path pattern, in three segment kinds: a literal, a :name that captures one segment, and a *name that captures everything left.

There are no regex constraints, no optional segments and no typed patterns. A typed pattern makes Route generic over its parameter tuple, which collides with the flat route table, and a regex constraint on a segment is the wrong home for what FromPath[A] already does by failing to a 400.

Attributes

Companion
object
Source
PathPattern.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
Source
PathPattern.scala
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
PathPattern.scala
def matchPath(path: String): Option[Map[String, String]]

The captured parameters when path matches, and nothing when it does not.

The captured parameters when path matches, and nothing when it does not.

Attributes

Source
PathPattern.scala
def render: String

The way back to the string this was parsed from. The dev = true boot print and the boot time warnings both name a path, and neither can reach for the source text.

The way back to the string this was parsed from. The dev = true boot print and the boot time warnings both name a path, and neither can reach for the source text.

Attributes

Source
PathPattern.scala
def subsumes(later: PathPattern): Boolean

Whether every path this pattern matches, a later pattern would have matched too.

Whether every path this pattern matches, a later pattern would have matched too.

The subsumption an earlier route needs to shadow a later one, decidable segment by segment because there are only three segment kinds: a Static swallows only an equal Static, a Param swallows any single segment, and a CatchAll swallows everything remaining. It is a one-way question, so /widgets/:id subsumes /widgets/new and never the reverse.

The two ragged ends are asymmetric for the same reason matchPath is: a trailing CatchAll matches zero segments, so a pattern ending in one subsumes the prefix it is appended to, while a pattern that runs out of segments first subsumes nothing.

Attributes

Source
PathPattern.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
PathPattern.scala

Concrete fields

val segments: Vector[Segment]

Attributes

Source
PathPattern.scala