SegmentCodec

zio.http.codec.SegmentCodec
See theSegmentCodec companion object
sealed trait SegmentCodec[A]

Attributes

Companion
object
Source
SegmentCodec.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Trailing
Self type

Members list

Type members

Types

final type Type = A

Attributes

Source
SegmentCodec.scala

Value members

Abstract methods

def format(value: A): Path

Attributes

Source
SegmentCodec.scala
def inSegmentUntil(segment: String, from: Int): Int

Attributes

Source
SegmentCodec.scala
def matches(segments: Chunk[String], index: Int): Int

Attributes

Source
SegmentCodec.scala

Concrete methods

final def ??(doc: Doc): PathCodec[A]

Attributes

Source
SegmentCodec.scala
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
Any
Source
SegmentCodec.scala
final def example(name: String, example: A): PathCodec[A]

Attributes

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

Attributes

Source
SegmentCodec.scala
final def isEmpty: Boolean

Attributes

Source
SegmentCodec.scala
final def nonEmpty: Boolean

Attributes

Source
SegmentCodec.scala
final def render: String

Attributes

Source
SegmentCodec.scala
final def render(prefix: String, suffix: String): String

Attributes

Source
SegmentCodec.scala
final def transform[A2](f: A => A2)(g: A2 => A): PathCodec[A2]

Attributes

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

Attributes

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

Attributes

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

Attributes

Source
SegmentCodec.scala
final def ~[B](that: SegmentCodec[B])(implicit combiner: Combiner[A, B], combinable: Combinable[B, SegmentCodec[B]]): SegmentCodec[combiner.Out]

Attributes

Source
SegmentCodec.scala
final def ~(that: String)(implicit combiner: Combiner[A, Unit]): SegmentCodec[combiner.Out]

Attributes

Source
SegmentCodec.scala

Concrete fields

override val 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.

Source
SegmentCodec.scala