Annotated

zio.http.codec.PathCodec.Annotated
final case class Annotated[A](codec: PathCodec[A], annotations: Chunk[MetaData[A]]) extends PathCodec[A]

Attributes

Source
PathCodec.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait PathCodec[A]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def equals(that: 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
Equals -> Any
Source
PathCodec.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
PathCodec.scala

Inherited methods

final def ++[B](that: PathCodec[B])(implicit combiner: Combiner[A, B]): PathCodec[combiner.Out]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def /[Env, Err](routes: Routes[Env, Err])(implicit ev: PathCodec[A] <:< PathCodec[Unit]): Routes[Env, Err]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def /[B](that: PathCodec[B])(implicit combiner: Combiner[A, B]): PathCodec[combiner.Out]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
def ??(doc: Doc): PathCodec[A]

Attaches documentation to the path codec, which may be used when generating developer docs for a route.

Attaches documentation to the path codec, which may be used when generating developer docs for a route.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def alternatives: List[PathCodec[A]]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def annotate(metaData: MetaData[A]): PathCodec[A]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def asType[B](implicit ev: A =:= B): PathCodec[B]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def decode(path: Path): Either[String, A]

Decodes a method and path into a value of type A.

Decodes a method and path into a value of type A.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
def doc: Doc

Returns the documentation for the path codec, if any.

Returns the documentation for the path codec, if any.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def encode(value: A): Either[String, Path]

Encodes a value of type A into the method and path that this route pattern would successfully match against.

Encodes a value of type A into the method and path that this route pattern would successfully match against.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def example(name: String, example: A): PathCodec[A]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def examples(examples: (String, A)*): PathCodec[A]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def format(value: A): Either[String, Path]

Formats a value of type A into a path. This is useful for embedding paths into HTML that is rendered by the server.

Formats a value of type A into a path. This is useful for embedding paths into HTML that is rendered by the server.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def matches(path: Path): Boolean

Determines if this pattern matches the specified method and path. Rather than use this method, you should just try to decode it directly, for higher performance, otherwise the same information will be decoded twice.

Determines if this pattern matches the specified method and path. Rather than use this method, you should just try to decode it directly, for higher performance, otherwise the same information will be decoded twice.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
def parseInt(s: CharSequence, beginIndex: Int, endIndex: Int, radix: Int): Int
def parseLong(s: CharSequence, beginIndex: Int, endIndex: Int, radix: Int): Long
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def render(prefix: String, suffix: String): String

Renders the path codec as a string. Surrounds the path variables with the specified prefix and suffix.

Renders the path codec as a string. Surrounds the path variables with the specified prefix and suffix.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
def render: String

Renders the path codec as a string.

Renders the path codec as a string.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
def segments: Chunk[SegmentCodec[_]]

Returns the segments of the path codec.

Returns the segments of the path codec.

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
def toPath(implicit ev: A =:= Unit): Path

Converts this PathCodec[Unit] to a Path using the encode method. Useful for round-trip conversion.

Converts this PathCodec[Unit] to a Path using the encode method. Useful for round-trip conversion.

Value parameters

ev

evidence that A =:= Unit

Attributes

Returns

the encoded Path, or Path.root if encoding fails

Inherited from:
PathCodec
Source
PathCodec.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
PathCodec -> Any
Inherited from:
PathCodec
Source
PathCodec.scala
final def transform[A2](f: A => A2)(g: A2 => A): PathCodec[A2]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def transformOrFail[A2](f: A => Either[String, A2])(g: A2 => Either[String, A]): PathCodec[A2]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def transformOrFailLeft[A2](f: A => Either[String, A2])(g: A2 => A): PathCodec[A2]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala
final def transformOrFailRight[A2](f: A => A2)(g: A2 => Either[String, A]): PathCodec[A2]

Attributes

Inherited from:
PathCodec
Source
PathCodec.scala