Packages

trait Terminator[A] extends Codec[(BitVector, A)]

Terminator is used to find chunk of data, that may be used to decode chunks of bits terminated by A

Source
Terminator.scala
Linear Supertypes
Codec[(BitVector, A)], GenCodec[(BitVector, A), (BitVector, A)], Decoder[(BitVector, A)], Encoder[(BitVector, A)], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Terminator
  2. Codec
  3. GenCodec
  4. Decoder
  5. Encoder
  6. AnyRef
  7. Any
Implicitly
  1. by Tuple2CodecSupport
  2. by EnrichedCoproductEncoder
  3. by ValueCodecEnrichedWithGenericSupport
  4. by ValueCodecEnrichedWithHListSupport
  5. by TransformSyntax
  6. by any2stringadd
  7. by StringFormat
  8. by Ensuring
  9. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def decode(bits: BitVector): Attempt[DecodeResult[(BitVector, A)]]
    Definition Classes
    Decoder
  2. abstract def encode(value: (BitVector, A)): Attempt[BitVector]
    Definition Classes
    Encoder
  3. abstract def sizeBound: SizeBound
    Definition Classes
    Encoder

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 Terminator[A] toany2stringadd[Terminator[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Terminator[A], B)
    Implicit
    This member is added by an implicit conversion from Terminator[A] toArrowAssoc[Terminator[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. def :+:[B](left: Codec[B]): CoproductCodecBuilder[:+:[B, :+:[(BitVector, A), CNil]], ::[Codec[B], ::[Codec[(BitVector, A)], HNil]], :+:[B, :+:[(BitVector, A), CNil]]]
    Definition Classes
    Codec
  6. def ::[B](codecB: Codec[B]): Codec[::[B, ::[(BitVector, A), HNil]]]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithHListSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithHListSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithHListSupport
  7. def :~>:[B](codecB: Codec[B])(implicit ev: =:=[Unit, B]): Codec[::[(BitVector, A), HNil]]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithHListSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithHListSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithHListSupport
  8. final def <~[B](codecB: Codec[B])(implicit ev: =:=[Unit, B]): Codec[(BitVector, A)]
    Definition Classes
    Codec
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def >>:~[L <: HList](f: ((BitVector, A)) => Codec[L]): Codec[::[(BitVector, A), L]]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithHListSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithHListSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithHListSupport
  11. final def >>~[B](f: ((BitVector, A)) => Codec[B]): Codec[((BitVector, A), B)]
    Definition Classes
    Codec
  12. def as[B](implicit as: Transformer[A, B]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  13. def asDecoder: Decoder[(BitVector, A)]
    Definition Classes
    Decoder
  14. def asEncoder: Encoder[(BitVector, A)]
    Definition Classes
    Encoder
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  17. final def compact: Codec[(BitVector, A)]
    Definition Classes
    Codec → GenCodec → Encoder
  18. final def complete: Codec[(BitVector, A)]
    Definition Classes
    Codec → GenCodec → Decoder
  19. final def consume[B](f: ((BitVector, A)) => Codec[B])(g: (B) => (BitVector, A)): Codec[B]
    Definition Classes
    Codec
  20. def contramap[C](f: (C) => (BitVector, A)): GenCodec[C, (BitVector, A)]
    Definition Classes
    GenCodec → Encoder
  21. def decodeOnly[AA >: (BitVector, A)]: Codec[AA]
    Definition Classes
    Codec → Decoder
  22. final def decodeValue(bits: BitVector): Attempt[(BitVector, A)]
    Definition Classes
    Decoder
  23. final def downcast[B <: (BitVector, A)](implicit tb: Typeable[B]): Codec[B]
    Definition Classes
    Codec
  24. final def dropLeft[B](codecB: Codec[B])(implicit ev: =:=[Unit, (BitVector, A)]): Codec[B]
    Definition Classes
    Codec
  25. final def dropRight[B](codecB: Codec[B])(implicit ev: =:=[Unit, B]): Codec[(BitVector, A)]
    Definition Classes
    Codec
  26. def econtramap[C](f: (C) => Attempt[(BitVector, A)]): GenCodec[C, (BitVector, A)]
    Definition Classes
    GenCodec → Encoder
  27. def emap[C](f: ((BitVector, A)) => Attempt[C]): GenCodec[(BitVector, A), C]
    Definition Classes
    GenCodec → Decoder
  28. def encodeOnly: Codec[(BitVector, A)]
    Definition Classes
    Encoder
  29. def ensuring(cond: (Terminator[A]) => Boolean, msg: => Any): Terminator[A]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toEnsuring[Terminator[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. def ensuring(cond: (Terminator[A]) => Boolean): Terminator[A]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toEnsuring[Terminator[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  31. def ensuring(cond: Boolean, msg: => Any): Terminator[A]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toEnsuring[Terminator[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  32. def ensuring(cond: Boolean): Terminator[A]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toEnsuring[Terminator[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  33. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  35. final def exmap[B](f: ((BitVector, A)) => Attempt[B], g: (B) => Attempt[(BitVector, A)]): Codec[B]
    Definition Classes
    Codec
  36. def exmapc[B](f: (A) => Attempt[B])(g: (B) => Attempt[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  38. def flatMap[B](f: ((BitVector, A)) => Decoder[B]): Decoder[B]
    Definition Classes
    Decoder
  39. def flatPrepend[L <: HList](f: ((BitVector, A)) => Codec[L]): Codec[::[(BitVector, A), L]]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithHListSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithHListSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithHListSupport
  40. final def flatZip[B](f: ((BitVector, A)) => Codec[B]): Codec[((BitVector, A), B)]
    Definition Classes
    Codec
  41. def flatZipHList[B](f: ((BitVector, A)) => Codec[B]): Codec[::[(BitVector, A), ::[B, HNil]]]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithHListSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithHListSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithHListSupport
  42. final def flattenLeftPairs(implicit f: FlattenLeftPairs[(BitVector, A)]): Codec[Out]
    Definition Classes
    Codec
  43. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Terminator[A] toStringFormat[Terminator[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  44. final def fuse[AA <: (BitVector, A), BB >: (BitVector, A)](implicit ev: =:=[BB, AA]): Codec[BB]
    Definition Classes
    GenCodec
  45. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  46. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. final def hlist: Codec[::[(BitVector, A), HNil]]
    Definition Classes
    Codec
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def map[C](f: ((BitVector, A)) => C): GenCodec[(BitVector, A), C]
    Definition Classes
    GenCodec → Decoder
  50. final def narrow[B](f: ((BitVector, A)) => Attempt[B], g: (B) => (BitVector, A)): Codec[B]
    Definition Classes
    Codec
  51. def narrowc[B](f: (A) => Attempt[B])(g: (B) => A): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. final def pairedWith[B](codecB: Codec[B]): Codec[((BitVector, A), B)]
    Definition Classes
    Codec
  56. def pcontramap[C](f: (C) => Option[(BitVector, A)]): GenCodec[C, (BitVector, A)]
    Definition Classes
    GenCodec → Encoder
  57. def polyxmap[B](p: Poly, q: Poly)(implicit aToB: Aux[p.type, ::[(BitVector, A), HNil], B], bToA: Aux[q.type, ::[B, HNil], (BitVector, A)]): Codec[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithGenericSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithGenericSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithGenericSupport
  58. def polyxmap1[B](p: Poly)(implicit aToB: Aux[p.type, ::[(BitVector, A), HNil], B], bToA: Aux[p.type, ::[B, HNil], (BitVector, A)]): Codec[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithGenericSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithGenericSupport in scodec.
    Definition Classes
    ValueCodecEnrichedWithGenericSupport
  59. def selectEncoder[A](implicit inj: Inject[Coproduct with (BitVector, A), A]): Encoder[A]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toEnrichedCoproductEncoder[Coproduct with (BitVector, A)] performed by method EnrichedCoproductEncoder in scodec.
    Definition Classes
    EnrichedCoproductEncoder
  60. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  61. def toField[K]: Codec[FieldType[K, (BitVector, A)]]
    Definition Classes
    Codec
  62. def toFieldWithContext[K <: Symbol](k: K): Codec[FieldType[K, (BitVector, A)]]
    Definition Classes
    Codec
  63. def toString(): String
    Definition Classes
    AnyRef → Any
  64. final def unit(zero: (BitVector, A)): Codec[Unit]
    Definition Classes
    Codec
  65. final def upcast[B >: (BitVector, A)](implicit ta: Typeable[(BitVector, A)]): Codec[B]
    Definition Classes
    Codec
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  69. final def widen[B](f: ((BitVector, A)) => B, g: (B) => Attempt[(BitVector, A)]): Codec[B]
    Definition Classes
    Codec
  70. def widenOpt[B](f: (A) => B, g: (B) => Option[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  71. def widenOptc[B](f: (A) => B)(g: (B) => Option[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  72. def widenc[B](f: (A) => B)(g: (B) => Attempt[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  73. final def withContext(context: String): Codec[(BitVector, A)]
    Definition Classes
    Codec
  74. final def withToString(str: => String): Codec[(BitVector, A)]
    Definition Classes
    Codec
  75. final def xmap[B](f: ((BitVector, A)) => B, g: (B) => (BitVector, A)): Codec[B]
    Definition Classes
    Codec
  76. def xmapc[B](f: (A) => B)(g: (B) => A): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
  77. final def ~[B](codecB: Codec[B]): Codec[((BitVector, A), B)]
    Definition Classes
    Codec
  78. final def ~>[B](codecB: Codec[B])(implicit ev: =:=[Unit, (BitVector, A)]): Codec[B]
    Definition Classes
    Codec
  79. def ~~[B](B: Codec[B]): TupleCodec[(BitVector, A), B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTuple2CodecSupport[(BitVector, A)] performed by method Tuple2CodecSupport in scodec.
    Definition Classes
    Tuple2CodecSupport

Shadowed Implicit Value Members

  1. def exmap[B](f: (A) => Attempt[B], g: (B) => Attempt[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (terminator: TransformSyntax[Terminator, A]).exmap(f, g)
    Definition Classes
    TransformSyntax
  2. def narrow[B](f: (A) => Attempt[B], g: (B) => A): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (terminator: TransformSyntax[Terminator, A]).narrow(f, g)
    Definition Classes
    TransformSyntax
  3. val self: Codec[(BitVector, A)]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTuple2CodecSupport[(BitVector, A)] performed by method Tuple2CodecSupport in scodec.
    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:
    (terminator: Tuple2CodecSupport[(BitVector, A)]).self
    Definition Classes
    Tuple2CodecSupport
  4. val self: Encoder[Coproduct with (BitVector, A)]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toEnrichedCoproductEncoder[Coproduct with (BitVector, A)] performed by method EnrichedCoproductEncoder in scodec.
    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:
    (terminator: EnrichedCoproductEncoder[Coproduct with (BitVector, A)]).self
    Definition Classes
    EnrichedCoproductEncoder
  5. val self: Codec[(BitVector, A)]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithGenericSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithGenericSupport in scodec.
    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:
    (terminator: ValueCodecEnrichedWithGenericSupport[(BitVector, A)]).self
    Definition Classes
    ValueCodecEnrichedWithGenericSupport
  6. val self: Codec[(BitVector, A)]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toValueCodecEnrichedWithHListSupport[(BitVector, A)] performed by method ValueCodecEnrichedWithHListSupport in scodec.
    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:
    (terminator: ValueCodecEnrichedWithHListSupport[(BitVector, A)]).self
    Definition Classes
    ValueCodecEnrichedWithHListSupport
  7. val self: Terminator[A]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    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:
    (terminator: TransformSyntax[Terminator, A]).self
    Definition Classes
    TransformSyntax
  8. def widen[B](f: (A) => B, g: (B) => Attempt[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (terminator: TransformSyntax[Terminator, A]).widen(f, g)
    Definition Classes
    TransformSyntax
  9. def xmap[B](f: (A) => B, g: (B) => A): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (terminator: TransformSyntax[Terminator, A]).xmap(f, g)
    Definition Classes
    TransformSyntax

Deprecated Value Members

  1. def pxmap[B](f: (A) => B, g: (B) => Option[A]): Terminator[B]
    Implicit
    This member is added by an implicit conversion from Terminator[A] toTransformSyntax[Terminator, A] performed by method TransformSyntax in scodec.This conversion will take place only if an implicit value of type Transform[Terminator] is in scope.
    Definition Classes
    TransformSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

  2. def →[B](y: B): (Terminator[A], B)
    Implicit
    This member is added by an implicit conversion from Terminator[A] toArrowAssoc[Terminator[A]] performed by method ArrowAssoc in scala.Predef.
    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 Codec[(BitVector, A)]

Inherited from GenCodec[(BitVector, A), (BitVector, A)]

Inherited from Decoder[(BitVector, A)]

Inherited from Encoder[(BitVector, A)]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion Tuple2CodecSupport fromTerminator[A] to Tuple2CodecSupport[(BitVector, A)]

Inherited by implicit conversion EnrichedCoproductEncoder fromTerminator[A] to EnrichedCoproductEncoder[Coproduct with (BitVector, A)]

Inherited by implicit conversion ValueCodecEnrichedWithGenericSupport fromTerminator[A] to ValueCodecEnrichedWithGenericSupport[(BitVector, A)]

Inherited by implicit conversion ValueCodecEnrichedWithHListSupport fromTerminator[A] to ValueCodecEnrichedWithHListSupport[(BitVector, A)]

Inherited by implicit conversion TransformSyntax fromTerminator[A] to TransformSyntax[Terminator, A]

Inherited by implicit conversion any2stringadd fromTerminator[A] to any2stringadd[Terminator[A]]

Inherited by implicit conversion StringFormat fromTerminator[A] to StringFormat[Terminator[A]]

Inherited by implicit conversion Ensuring fromTerminator[A] to Ensuring[Terminator[A]]

Inherited by implicit conversion ArrowAssoc fromTerminator[A] to ArrowAssoc[Terminator[A]]

Ungrouped