scalax.io

Visibility

Public
All

Type Members

trait Adapter [+S] extends AnyRef

Supporting classes for converting between resource types.
class ArrayBufferSeekableChannel extends SeekableByteChannel
class ByteChannelResource [+A <: ByteChannel] extends InputResource[A] with OutputResource[A] with ResourceOps[A, ByteChannelResource[A]]

A for accessing and using ByteChannels.
class CharInputStream extends InputStream

Attributes
protected
trait CloseAction [-A] extends AnyRef

A strategy object representing an action to take upon closing a Resource.
trait CloseableIterator [+A] extends Iterator[A] with Closeable
class CloseableOpenedResource [+R <: Closeable] extends OpenedResource[R]
class Codec extends AnyRef

A class for character encoding/decoding preferences.
case class Continue [+A] (currentResult: A) extends FoldResult[A] with Product with Serializable

Signal indicating that the fold should continue to process another value
case class End [+A] (endResult: A) extends FoldResult[A] with Product with Serializable

Signal indicating that the fold should stop and return the contained result
class FoldResult [+A] extends AnyRef

The control signals for the limitFold method in LongTraversable.
trait Input extends AnyRef

An trait for objects that viewed as a sequence of bytes.
trait InputResource [+R <: Closeable] extends Resource[R] with Input with ResourceOps[R, InputResource[R]]

An Resource object that is a also an Input.
class InputStreamResource [+A <: InputStream] extends InputResource[A] with ResourceOps[A, InputStreamResource[A]]

A ManagedResource for accessing and using InputStreams.
case class KnownName (name: String) extends ResourceDescName with Product with Serializable
class LineTraversable extends LongTraversable[String]

Creates a Traversable[String] from a Traversable[Char] where each String is a line as indicated by the Terminator.
trait LongTraversable [+A] extends Traversable[A] with GenericTraversableTemplate[A, LongTraversable] with LongTraversableLike[A, LongTraversable[A]]

A traversable for use on very large datasets which cannot be indexed with Ints but instead require Longs for indexing.
trait LongTraversableLike [+A, +Repr <: LongTraversableLike[A, Repr]] extends TraversableLike[A, Repr]

A traversable for use on very large datasets which cannot be indexed with Ints but instead require Longs for indexing.
trait LongTraversableView [+A, +Coll] extends LongTraversableViewLike[A, Coll, LongTraversableView[A, Coll]]

The view object associated with LongTraversable.
trait LongTraversableViewLike [+A, +Coll, +This <: LongTraversableView[A, Coll] with LongTraversableViewLike[A, Coll, This]] extends LongTraversable[A] with LongTraversableLike[A, This] with TraversableView[A, Coll] with TraversableViewLike[A, Coll, This]

The actual LongTraversableView implementations.
trait OpenOption extends AnyRef

A flag interface for indicating that the object represents a filesystem dependent option for opening a file.
type OpenSeekable = Seekable { ... /* 2 definitions in type refinement */ }

Definition Classes
package
trait OpenedResource [+R] extends AnyRef
trait Output extends AnyRef

A trait for objects that can have data written to them.
trait OutputConverter [-T] extends (OutputStream, T) ⇒ Unit

Functions used by Seekable and Output to either convert data to bytes for writing or write directly to an output stream depending on the requirements of the caller.
trait OutputResource [+R <: Closeable] extends Resource[R] with Output with ResourceOps[R, OutputResource[R]]

An Resource object that is a also an Output.
class OutputStreamResource [+A <: OutputStream] extends OutputResource[A] with ResourceOps[A, OutputStreamResource[A]]

A ManagedResource for accessing and using OutputStreams.
trait Overwrite extends AnyRef

A strategy trait used with the Seekable.
case class OverwriteSome (replacementLength: Long) extends Overwrite with Product with Serializable

Strategy for (potentially) only overwriting a subset of the data.
case class PrefixedName (prefix: String) extends ResourceDescName with Product with Serializable
trait ReadChars extends AnyRef

An trait for objects that viewed as a sequence of characters.
trait ReadCharsResource [+R <: Closeable] extends Resource[R] with ReadChars with ResourceOps[R, ReadCharsResource[R]]

An object that in addition to being a resource is also a ReadChars Resource.
class ReadableByteChannelResource [+A <: ReadableByteChannel] extends InputResource[A] with ResourceOps[A, ReadableByteChannelResource[A]]

A ManagedResource for accessing and using ByteChannels.
class ReaderResource [+A <: Reader] extends ReadCharsResource[A] with ResourceOps[A, ReaderResource[A]]

A ManagedResource for accessing and using Readers.
trait Resource [+R <: Closeable] extends ManagedResourceOperations[R] with ResourceOps[R, Resource[R]]

A Resource that can be used to do IO.
trait ResourceDescName extends AnyRef

Attributes
sealed
trait ResourceOps [+R, +Repr] extends AnyRef

A trait allowing adding close actions to a Resource.
type ResourceView [A] = LongTraversableView[A, LongTraversable[A]]

An alias from LongTraversableView[A,LongTraversable[A]].
An alias from LongTraversableView[A,LongTraversable[A]]. The only purpose is to make the type signatures easier to read

Definition Classes
package
trait Seekable extends Input with Output

An object for reading and writing to Random Access IO objects such as Files.
trait SeekableByteChannel extends ByteChannel with Channel with Closeable with ReadableByteChannel with WritableByteChannel

An object for reading and writing to Random Access IO objects such as Files.
class SeekableByteChannelResource [+A <: SeekableByteChannel] extends SeekableResource[A] with ResourceOps[A, SeekableByteChannelResource[A]]

A ManagedResource for accessing and using SeekableByteChannels.
trait SeekableResource [+R <: Closeable] extends Seekable with InputResource[R] with OutputResource[R] with ResourceOps[R, SeekableResource[R]]

An object that can be viewed as a Seekable object.
class StreamIterator [E] extends Iterator[E]

Attributes
protected
trait TraversableSource [In <: Closeable, A] extends AnyRef

A way of abstracting over the source Resource's type
case class UnknownName () extends ResourceDescName with Product with Serializable
class WritableByteChannelResource [+A <: WritableByteChannel] extends OutputResource[A] with ResourceOps[A, WritableByteChannelResource[A]]

A ManagedResource for accessing and using ByteChannels.
trait WriteChars extends AnyRef

A trait for objects that can have expect to have characters written to them.
trait WriteCharsResource [+R <: Closeable] extends Resource[R] with WriteChars with ResourceOps[R, WriteCharsResource[R]]

An object that in addition to being a resource is also a WriteChars Resource.
class WriterOutputStream extends OutputStream

Takes a writer and allows it to be treated like a OutputStream, The data is encoded as it is written to the Writer
class WriterResource [+A <: Writer] extends WriteCharsResource[A] with ResourceOps[A, WriterResource[A]]

A ManagedResource for accessing and using Writers.

Value Members

object Buffers extends AnyRef

Not public API.
object CloseAction extends AnyRef

Factory for CloseAction.
object CloseableIterator extends AnyRef
object Codec extends AnyRef
object JavaConverters extends AnyRef
object Line extends AnyRef

A modularizing object for containing objects/classes related to reading lines
object LongTraversable extends GenTraversableFactory[LongTraversable] with TraversableFactory[LongTraversable]

This class is not interesting from an API point of view.
object LongTraversableLike extends AnyRef
object LongTraversableView extends AnyRef

Defines the required canBuildFrom and Type definitions.
object OutputConverter extends AnyRef

Contains implicit Converter objects for the compiler to resolve the converters for write operations
object OverwriteAll extends Overwrite with Product with Serializable

Strategy to overwrite as much data as possible.
object Resource extends AnyRef

Defines several factory methods for creating instances of Resource.
object ResourceAdapting extends AnyRef

Contains a method
object StandardOpenOption extends Enumeration

Several options that are supported by most filesystems.
package extractor
package nio
package support
package traversable

io

package io

Type Members

trait Adapter [+S] extends AnyRef

class ArrayBufferSeekableChannel extends SeekableByteChannel

class ByteChannelResource [+A <: ByteChannel] extends InputResource[A] with OutputResource[A] with ResourceOps[A, ByteChannelResource[A]]

class CharInputStream extends InputStream

trait CloseAction [-A] extends AnyRef

trait CloseableIterator [+A] extends Iterator[A] with Closeable

class CloseableOpenedResource [+R <: Closeable] extends OpenedResource[R]

class Codec extends AnyRef

case class Continue [+A] (currentResult: A) extends FoldResult[A] with Product with Serializable

case class End [+A] (endResult: A) extends FoldResult[A] with Product with Serializable

class FoldResult [+A] extends AnyRef

trait Input extends AnyRef

trait InputResource [+R <: Closeable] extends Resource[R] with Input with ResourceOps[R, InputResource[R]]

class InputStreamResource [+A <: InputStream] extends InputResource[A] with ResourceOps[A, InputStreamResource[A]]

case class KnownName (name: String) extends ResourceDescName with Product with Serializable

class LineTraversable extends LongTraversable[String]

trait LongTraversable [+A] extends Traversable[A] with GenericTraversableTemplate[A, LongTraversable] with LongTraversableLike[A, LongTraversable[A]]

trait LongTraversableLike [+A, +Repr <: LongTraversableLike[A, Repr]] extends TraversableLike[A, Repr]

trait LongTraversableView [+A, +Coll] extends LongTraversableViewLike[A, Coll, LongTraversableView[A, Coll]]

trait LongTraversableViewLike [+A, +Coll, +This <: LongTraversableView[A, Coll] with LongTraversableViewLike[A, Coll, This]] extends LongTraversable[A] with LongTraversableLike[A, This] with TraversableView[A, Coll] with TraversableViewLike[A, Coll, This]

trait OpenOption extends AnyRef

type OpenSeekable = Seekable { ... /* 2 definitions in type refinement */ }

trait OpenedResource [+R] extends AnyRef

trait Output extends AnyRef

trait OutputConverter [-T] extends (OutputStream, T) ⇒ Unit

trait OutputResource [+R <: Closeable] extends Resource[R] with Output with ResourceOps[R, OutputResource[R]]

class OutputStreamResource [+A <: OutputStream] extends OutputResource[A] with ResourceOps[A, OutputStreamResource[A]]

trait Overwrite extends AnyRef

case class OverwriteSome (replacementLength: Long) extends Overwrite with Product with Serializable

case class PrefixedName (prefix: String) extends ResourceDescName with Product with Serializable

trait ReadChars extends AnyRef

trait ReadCharsResource [+R <: Closeable] extends Resource[R] with ReadChars with ResourceOps[R, ReadCharsResource[R]]

class ReadableByteChannelResource [+A <: ReadableByteChannel] extends InputResource[A] with ResourceOps[A, ReadableByteChannelResource[A]]

class ReaderResource [+A <: Reader] extends ReadCharsResource[A] with ResourceOps[A, ReaderResource[A]]

trait Resource [+R <: Closeable] extends ManagedResourceOperations[R] with ResourceOps[R, Resource[R]]

trait ResourceDescName extends AnyRef

trait ResourceOps [+R, +Repr] extends AnyRef

type ResourceView [A] = LongTraversableView[A, LongTraversable[A]]

trait Seekable extends Input with Output

trait SeekableByteChannel extends ByteChannel with Channel with Closeable with ReadableByteChannel with WritableByteChannel

class SeekableByteChannelResource [+A <: SeekableByteChannel] extends SeekableResource[A] with ResourceOps[A, SeekableByteChannelResource[A]]

trait SeekableResource [+R <: Closeable] extends Seekable with InputResource[R] with OutputResource[R] with ResourceOps[R, SeekableResource[R]]

class StreamIterator [E] extends Iterator[E]

trait TraversableSource [In <: Closeable, A] extends AnyRef

case class UnknownName () extends ResourceDescName with Product with Serializable

class WritableByteChannelResource [+A <: WritableByteChannel] extends OutputResource[A] with ResourceOps[A, WritableByteChannelResource[A]]

trait WriteChars extends AnyRef

trait WriteCharsResource [+R <: Closeable] extends Resource[R] with WriteChars with ResourceOps[R, WriteCharsResource[R]]

class WriterOutputStream extends OutputStream

class WriterResource [+A <: Writer] extends WriteCharsResource[A] with ResourceOps[A, WriterResource[A]]

Value Members

object Buffers extends AnyRef

object CloseAction extends AnyRef

object CloseableIterator extends AnyRef

object Codec extends AnyRef

object JavaConverters extends AnyRef

object Line extends AnyRef

object LongTraversable extends GenTraversableFactory[LongTraversable] with TraversableFactory[LongTraversable]

object LongTraversableLike extends AnyRef

object LongTraversableView extends AnyRef

object OutputConverter extends AnyRef

object OverwriteAll extends Overwrite with Product with Serializable

object Resource extends AnyRef

object ResourceAdapting extends AnyRef

object StandardOpenOption extends Enumeration

package extractor

package nio

package support

package traversable