core
API
Generated with
core/io.bullet.borer/Output

Output

io.bullet.borer.Output
See theOutput companion trait
object Output extends ToByteArrayOutput, ToByteBufferOutput, ToFileOutput, ToOutputStreamOutput, ToUnitOutput

Attributes

Companion
trait
Graph
Supertypes
trait ToUnitOutput
trait ToFileOutput
class Object
trait Matchable
class Any
Show all
Self type
Output.type

Members list

Type members

Classlikes

final implicit class OutputOps(val underlying: Output) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
trait ToTypeProvider[T]

Responsible for providing an Output that produces instances of T.

Responsible for providing an Output that produces instances of T.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ToByteArrayProvider.type
object ToByteBufferProvider.type
object ToUnitProvider.type
trait ToValueProvider[T]

Responsible for providing an Output that outputs into the given value T.

Responsible for providing an Output that outputs into the given value T.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ToFileProvider.type

Inherited classlikes

final class ToByteArray(bufferSize: Int, allowBufferCaching: Boolean) extends Output

Default, mutable implementation for serializing to plain byte arrays.

Default, mutable implementation for serializing to plain byte arrays.

Attributes

Inherited from:
ToByteArrayOutput
Supertypes
trait Output
class Object
trait Matchable
class Any
object ToByteArrayProvider extends ToTypeProvider[Array[Byte]]

Attributes

Inherited from:
ToByteArrayOutput
Supertypes
trait ToTypeProvider[Array[Byte]]
class Object
trait Matchable
class Any
final class ToByteBuffer(bufferSize: Int, allowBufferCaching: Boolean) extends Output

Default, mutable implementation for serializing to java.nio.ByteBuffer instances.

Default, mutable implementation for serializing to java.nio.ByteBuffer instances.

Attributes

Inherited from:
ToByteBufferOutput
Supertypes
trait Output
class Object
trait Matchable
class Any
object ToByteBufferProvider extends ToTypeProvider[ByteBuffer]

Attributes

Inherited from:
ToByteBufferOutput
Supertypes
trait ToTypeProvider[ByteBuffer]
class Object
trait Matchable
class Any
final class ToFile(file: File, bufferSize: Int) extends ToOutputStreamBase

Default, mutable implementation for serializing to a given File.

Default, mutable implementation for serializing to a given File.

Attributes

Inherited from:
ToFileOutput
Supertypes
trait Output
class Object
trait Matchable
class Any
object ToFileProvider extends ToValueProvider[File]

Attributes

Inherited from:
ToFileOutput
Supertypes
trait ToValueProvider[File]
class Object
trait Matchable
class Any
final class ToOutputStream(outputStream: OutputStream) extends ToOutputStreamBase

Default, mutable implementation for serializing to OutputStream instances.

Default, mutable implementation for serializing to OutputStream instances.

NOTE: The given OutputStream is NOT closed at the end of the encoding run!

Attributes

Inherited from:
ToOutputStreamOutput
Supertypes
trait Output
class Object
trait Matchable
class Any
abstract class ToOutputStreamBase(val outputStream: OutputStream) extends Output

Attributes

Inherited from:
ToOutputStreamOutput
Supertypes
trait Output
class Object
trait Matchable
class Any
Known subtypes
class ToFile
object ToOutputStreamProvider extends ToValueProvider[OutputStream]

Attributes

Inherited from:
ToOutputStreamOutput
Supertypes
trait ToValueProvider[OutputStream]
class Object
trait Matchable
class Any
object ToUnitProvider extends ToTypeProvider[Unit], Output

Simple NOP output that doesn't actually write anything and always produces Unit. Useful for running an encoding purely for its side effects, e.g. logging or validation.

Simple NOP output that doesn't actually write anything and always produces Unit. Useful for running an encoding purely for its side effects, e.g. logging or validation.

Attributes

Inherited from:
ToUnitOutput
Supertypes
trait Output
trait ToTypeProvider[Unit]
class Object
trait Matchable
class Any

Implicits

Implicits

final implicit def OutputOps(underlying: Output): OutputOps
Generated with