fs2-protocols
3.11.0
API
Generated with
fs2-protocols/fs2.protocols/fs2.protocols.pcapng/ByteOrderMagic

ByteOrderMagic

fs2.protocols.pcapng.ByteOrderMagic
object ByteOrderMagic extends Codec[ByteOrdering]

Attributes

Source
ByteOrderMagic.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def decode(buf: BitVector): Attempt[DecodeResult[ByteOrdering]]

Attempts to decode a value of type A from the specified bit vector.

Attempts to decode a value of type A from the specified bit vector.

Value parameters

bits

bits to decode

Attributes

Returns

error if value could not be decoded or the remaining bits and the decoded value

Source
ByteOrderMagic.scala
def encode(bo: ByteOrdering): Attempt[BitVector]

Attempts to encode the specified value in to a bit vector.

Attempts to encode the specified value in to a bit vector.

Value parameters

value

value to encode

Attributes

Returns

error or binary encoding of the value

Source
ByteOrderMagic.scala
def sizeBound: SizeBound

Provides a bound on the size of successfully encoded values.

Provides a bound on the size of successfully encoded values.

Attributes

Source
ByteOrderMagic.scala

Inherited methods

final def <~[B](codecB: Codec[B])(using Unit =:= B): Codec[ByteOrdering]

Assuming B is Unit, creates a Codec[A] that: encodes the A followed by a unit; decodes an A followed by a unit and discards the decoded unit.

Assuming B is Unit, creates a Codec[A] that: encodes the A followed by a unit; decodes an A followed by a unit and discards the decoded unit.

Operator alias of dropRight.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def >>~[B](f: ByteOrdering => Codec[B]): Codec[(ByteOrdering, B)]

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A.

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A. Operator alias for flatZip.

Attributes

Inherited from:
Codec
Source
Codec.scala
def as[B](using iso: Iso[ByteOrdering, B]): Codec[B]

Transforms this codec to a Codec[B] if A is isomorphic to B.

Transforms this codec to a Codec[B] if A is isomorphic to B.

This is most commonly used to convert a tuple codec to a case class:

Attributes

Example 

case class Point(x: Int, y: Int, z: Int)
val c: Codec[(Int, Int, Int)] = int8 :: int8 :: int8
val p: Codec[Point] = c.as[Point]
Inherited from:
Codec
Source
Codec.scala
def asDecoder: Decoder[ByteOrdering]

Gets this as a Decoder.

Gets this as a Decoder.

Attributes

Inherited from:
Decoder
Source
Decoder.scala
def asEncoder: Encoder[ByteOrdering]

Gets this as an Encoder.

Gets this as an Encoder.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
def collect[F[_], A2 >: ByteOrdering](buffer: BitVector, limit: Option[Int])(using factory: Factory[A2, F[A2]]): Attempt[DecodeResult[F[A2]]]

Repeatedly decodes values of type A from the specified vector and returns a collection of the specified type.

Repeatedly decodes values of type A from the specified vector and returns a collection of the specified type. Terminates when no more bits are available in the vector or when limit is defined and that many records have been decoded. Exits upon first decoding error.

Attributes

Inherited from:
Decoder
Source
Decoder.scala
final override def compact: Codec[ByteOrdering]

Converts this encoder to a new encoder that compacts the generated bit vector before returning it

Converts this encoder to a new encoder that compacts the generated bit vector before returning it

Attributes

Definition Classes
Inherited from:
Codec
Source
Codec.scala
final override def complete: Codec[ByteOrdering]

Converts this decoder to a new decoder that fails decoding if there are remaining bits.

Converts this decoder to a new decoder that fails decoding if there are remaining bits.

Attributes

Definition Classes
Inherited from:
Codec
Source
Codec.scala
final def consume[B](f: ByteOrdering => Codec[B])(g: B => ByteOrdering): Codec[B]

Similar to flatZip except the A type is not visible in the resulting type -- the binary effects of the Codec[A] still occur though.

Similar to flatZip except the A type is not visible in the resulting type -- the binary effects of the Codec[A] still occur though.

Example usage:

case class Flags(x: Boolean, y: Boolean, z: Boolean)
(bool :: bool :: bool :: ignore(5)).consume { flgs =>
  conditional(flgs.x, uint8) :: conditional(flgs.y, uint8) :: conditional(flgs.z, uint8)
} {
  case (x, y, z) => Flags(x.isDefined, y.isDefined, z.isDefined) }
}

Attributes

Inherited from:
Codec
Source
Codec.scala
def contramap[B](f: B => ByteOrdering): Encoder[B]

Converts this encoder to an Encoder[B] using the supplied B => A.

Converts this encoder to an Encoder[B] using the supplied B => A.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
final def decodeAll[B](f: ByteOrdering => B)(zero: B, append: (B, B) => B)(buffer: BitVector): (Option[Err], B)

Repeatedly decodes values of type A from the specified vector, converts each value to a B and appends it to an accumulator of type B using the supplied zero value and append function.

Repeatedly decodes values of type A from the specified vector, converts each value to a B and appends it to an accumulator of type B using the supplied zero value and append function. Terminates when no more bits are available in the vector. Exits upon first decoding error.

Attributes

Returns

tuple consisting of the terminating error if any and the accumulated value

Inherited from:
Decoder
Source
Decoder.scala
override def decodeOnly[AA >: ByteOrdering]: Codec[AA]

Converts this to a codec that fails encoding with an error.

Converts this to a codec that fails encoding with an error.

Attributes

Definition Classes
Inherited from:
Codec
Source
Codec.scala
final def decodeValue(bits: BitVector): Attempt[ByteOrdering]

Attempts to decode a value of type A from the specified bit vector and discards the remaining bits.

Attempts to decode a value of type A from the specified bit vector and discards the remaining bits.

Value parameters

bits

bits to decode

Attributes

Returns

error if value could not be decoded or the decoded value

Inherited from:
Decoder
Source
Decoder.scala
final def downcast[B <: ByteOrdering](using TypeTest[ByteOrdering, B]): Codec[B]

Safely lifts this codec to a codec of a subtype.

Safely lifts this codec to a codec of a subtype.

When a supertype of B that is not a supertype of A is decoded, an decoding error is returned.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def dropLeft[B](codecB: Codec[B])(using ev: Unit =:= ByteOrdering): Codec[B]

Assuming A is Unit, creates a Codec[B] that: encodes the unit followed by a B; decodes a unit followed by a B and discards the decoded unit.

Assuming A is Unit, creates a Codec[B] that: encodes the unit followed by a B; decodes a unit followed by a B and discards the decoded unit.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def dropRight[B](codecB: Codec[B])(using ev: Unit =:= B): Codec[ByteOrdering]

Assuming B is Unit, creates a Codec[A] that: encodes the A followed by a unit; decodes an A followed by a unit and discards the decoded unit.

Assuming B is Unit, creates a Codec[A] that: encodes the A followed by a unit; decodes an A followed by a unit and discards the decoded unit.

Attributes

Inherited from:
Codec
Source
Codec.scala
def econtramap[B](f: B => Attempt[ByteOrdering]): Encoder[B]

Converts this encoder to an Encoder[B] using the supplied B => Attempt[A].

Converts this encoder to an Encoder[B] using the supplied B => Attempt[A].

Attributes

Inherited from:
Encoder
Source
Encoder.scala
def emap[B](f: ByteOrdering => Attempt[B]): Decoder[B]

Converts this decoder to a Decoder[B] using the supplied A => Attempt[B].

Converts this decoder to a Decoder[B] using the supplied A => Attempt[B].

Attributes

Inherited from:
Decoder
Source
Decoder.scala
def encodeAll(as: Iterable[ByteOrdering]): Attempt[BitVector]

Encodes all elements of the specified sequence and concatenates the results, or returns the first encountered error.

Encodes all elements of the specified sequence and concatenates the results, or returns the first encountered error.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
def encodeOnly: Codec[ByteOrdering]

Converts this to a codec that fails decoding with an error.

Converts this to a codec that fails decoding with an error.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
final def exmap[B](f: ByteOrdering => Attempt[B], g: B => Attempt[ByteOrdering]): Codec[B]

Transforms using two functions, A => Attempt[B] and B => Attempt[A].

Transforms using two functions, A => Attempt[B] and B => Attempt[A].

Attributes

Inherited from:
Codec
Source
Codec.scala
def flatMap[B](f: ByteOrdering => Decoder[B]): Decoder[B]

Converts this decoder to a Decoder[B] using the supplied A => Decoder[B].

Converts this decoder to a Decoder[B] using the supplied A => Decoder[B].

Attributes

Inherited from:
Decoder
Source
Decoder.scala
final def flatZip[B](f: ByteOrdering => Codec[B]): Codec[(ByteOrdering, B)]

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A.

Returns a new codec that encodes/decodes a value of type (A, B) where the codec of B is dependent on A.

Attributes

Inherited from:
Codec
Source
Codec.scala
def map[B](f: ByteOrdering => B): Decoder[B]

Converts this decoder to a Decoder[B] using the supplied A => B.

Converts this decoder to a Decoder[B] using the supplied A => B.

Attributes

Inherited from:
Decoder
Source
Decoder.scala
def pcontramap[B](f: B => Option[ByteOrdering]): Encoder[B]

Converts this encoder to an Encoder[B] using the supplied partial function from B to A.

Converts this encoder to an Encoder[B] using the supplied partial function from B to A. The encoding will fail for any B that f maps to None.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
final def tuple: Codec[ByteOrdering *: EmptyTuple]

Lifts this codec in to a codec of a singleton tuple.

Lifts this codec in to a codec of a singleton tuple.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def unit(zero: ByteOrdering): Codec[Unit]

Converts this to a Codec[Unit] that encodes using the specified zero value and decodes a unit value when this codec decodes an A successfully.

Converts this to a Codec[Unit] that encodes using the specified zero value and decodes a unit value when this codec decodes an A successfully.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def upcast[B >: ByteOrdering](using TypeTest[B, ByteOrdering]): Codec[B]

Safely lifts this codec to a codec of a supertype.

Safely lifts this codec to a codec of a supertype.

When a subtype of B that is not a subtype of A is passed to encode, an encoding error is returned.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def withContext(context: String): Codec[ByteOrdering]

Creates a new codec that is functionally equivalent to this codec but pushes the specified context string in to any errors returned from encode or decode.

Creates a new codec that is functionally equivalent to this codec but pushes the specified context string in to any errors returned from encode or decode.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def withToString(str: => String): Codec[ByteOrdering]

Creates a new codec that is functionally equivalent to this codec but returns the specified string from toString.

Creates a new codec that is functionally equivalent to this codec but returns the specified string from toString.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def xmap[B](f: ByteOrdering => B, g: B => ByteOrdering): Codec[B]

Transforms using the isomorphism described by two functions, A => B and B => A.

Transforms using the isomorphism described by two functions, A => B and B => A.

Attributes

Inherited from:
Codec
Source
Codec.scala
final def ~>[B](codecB: Codec[B])(using Unit =:= ByteOrdering): Codec[B]

Assuming A is Unit, creates a Codec[B] that: encodes the unit followed by a B; decodes a unit followed by a B and discards the decoded unit.

Assuming A is Unit, creates a Codec[B] that: encodes the unit followed by a B; decodes a unit followed by a B and discards the decoded unit.

Operator alias of dropLeft.

Attributes

Inherited from:
Codec
Source
Codec.scala

Deprecated and Inherited methods

final def hlist: Codec[ByteOrdering *: EmptyTuple]

Attributes

Deprecated
true
Inherited from:
Codec
Source
Codec.scala
Generated with