Trait/Object

kantan.codecs.resource

Resource

Related Docs: object Resource | package resource

Permalink

trait Resource[I, R] extends AnyRef

Represents a resource that can be opened and worked on.

The purpose of this trait is to abstract over the notion of "things that can be opened", such as files, URLs... Default instances are provided for java.io types - java.io.File, for example, has instances for both opening it for reading and for writing.

I

type of the resource itself (eg java.io.File).

R

type of the opened resource (eg java.io.InputStream)

Self Type
Resource[I, R]
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Resource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def open(input: I): OpenResult[R]

    Permalink

    Opens the specified resource.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def contramap[II](f: (II) ⇒ I): Resource[II, R]

    Permalink
  7. def econtramap[II](f: (II) ⇒ OpenResult[I]): Resource[II, R]

    Permalink
  8. def emap[RR](f: (R) ⇒ OpenResult[RR]): Resource[I, RR]

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def map[RR](f: (R) ⇒ RR): Resource[I, RR]

    Permalink
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. def withResource[O](input: I)(f: (R) ⇒ ProcessResult[O])(implicit c: Closeable[R]): ResourceResult[O]

    Permalink

    Opens the specified resource and applies the specified function to its content.

    Opens the specified resource and applies the specified function to its content.

    The resource will be closed regardless of whether f fails. Note that f is expected to be safe - it cannot throw but should instead wrap all errors in a ProcessResult.

Deprecated Value Members

  1. def contramapResult[II](f: (II) ⇒ OpenResult[I]): Resource[II, R]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.3.1) Use econtramap instead

  2. def mapResult[RR](f: (R) ⇒ OpenResult[RR]): Resource[I, RR]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.3.1) Use emap instead

Inherited from AnyRef

Inherited from Any

Ungrouped