Packages

class ContainerResource[F[_], Tag] extends Basic[F, DockerContainer[Tag]]

Linear Supertypes
Basic[F, DockerContainer[Tag]], Lifecycle[F, DockerContainer[Tag]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContainerResource
  2. Basic
  3. Lifecycle
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ContainerResource(config: ContainerConfig[Tag], client: DockerClientWrapper[F], logger: IzLogger, deps: Set[DockerContainer[Any]])(implicit F: QuasiIO[F], P: QuasiAsync[F], T: QuasiTemporal[F])

Type Members

  1. final type InnerResource = DockerContainer[Tag]
    Definition Classes
    Basic → Lifecycle

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val F: QuasiIO[F]
  5. implicit val P: QuasiAsync[F]
  6. implicit val T: QuasiTemporal[F]
  7. def acquire: F[DockerContainer[Tag]]

    The action in F used to acquire the resource.

    The action in F used to acquire the resource.

    Definition Classes
    ContainerResource → Basic → Lifecycle
    Note

    the acquire action is performed *uninterruptibly*, when F is an effect type that supports interruption/cancellation.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def await(container0: DockerContainer[Tag]): F[DockerContainer[Tag]]
    Attributes
    protected
  10. final def beforeAcquire[G[x] >: F[x]](f: => G[Unit])(implicit arg0: QuasiApplicative[G]): Lifecycle[G, DockerContainer[Tag]]
    Definition Classes
    Lifecycle
  11. final def beforeRelease[G[x] >: F[x]](f: (InnerResource) => G[Unit])(implicit arg0: QuasiApplicative[G]): Lifecycle[G, DockerContainer[Tag]]

    Prepend release action to existing

    Prepend release action to existing

    Definition Classes
    Lifecycle
  12. final def catchAll[G[x] >: F[x], B >: DockerContainer[Tag]](recover: (Throwable) => Lifecycle[G, B])(implicit arg0: QuasiIO[G]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  13. final def catchSome[G[x] >: F[x], B >: DockerContainer[Tag]](recover: PartialFunction[Throwable, Lifecycle[G, B]])(implicit arg0: QuasiIO[G]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  14. val client: DockerClientWrapper[F]
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. val config: ContainerConfig[Tag]
  17. def copy(config: ContainerConfig[Tag] = config, client: DockerClientWrapper[F] = client, logger: IzLogger = logger, deps: Set[DockerContainer[Any]] = deps, F: QuasiIO[F] = F, P: QuasiAsync[F] = P, T: QuasiTemporal[F] = T): ContainerResource[F, Tag]
  18. val deps: Set[DockerContainer[Any]]
  19. def doPull(imageName: String, registry: Option[String], registryAuth: Option[AuthConfig]): F[Unit]
    Attributes
    protected
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. final def evalMap[G[x] >: F[x], B](f: (DockerContainer[Tag]) => G[B])(implicit arg0: QuasiPrimitives[G]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  23. final def evalTap[G[x] >: F[x]](f: (DockerContainer[Tag]) => G[Unit])(implicit arg0: QuasiPrimitives[G]): Lifecycle[G, DockerContainer[Tag]]
    Definition Classes
    Lifecycle
  24. final def extract[B >: DockerContainer[Tag]](resource: DockerContainer[Tag]): Right[Nothing, DockerContainer[Tag]]

    Either an action in F or a pure function used to extract the A from the InnerResource

    Either an action in F or a pure function used to extract the A from the InnerResource

    The effect in the Left branch will be performed *interruptibly*, it is not afforded the same kind of safety as acquire and release actions when F is an effect type that supports interruption/cancellation.

    When F is Identity, it doesn't matter whether the output is a Left or Right branch.

    When consuming the output of extract you can use _.fold(identity, F.pure) to convert the Either to F[B]

    Definition Classes
    Basic → Lifecycle
    See also

    Lifecycle.Basic extract doesn't have to be defined when inheriting from Lifecycle.Basic

  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. final def flatMap[G[x] >: F[x], B](f: (DockerContainer[Tag]) => Lifecycle[G, B])(implicit arg0: QuasiPrimitives[G]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  27. final def flatten[G[x] >: F[x], B](implicit arg0: QuasiPrimitives[G], ev: <:<[DockerContainer[Tag], Lifecycle[G, B]]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def inspectContainerAndGetState(containerId: String): Either[Throwable, ContainerState]
    Attributes
    protected
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. val logger: IzLogger
  33. final def map[G[x] >: F[x], B](f: (DockerContainer[Tag]) => B)(implicit arg0: QuasiFunctor[G]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  34. def mapContainerPorts(inspection: InspectContainerResponse): Either[UnmappedPorts, ReportedContainerConnectivity]
    Attributes
    protected
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def redeem[G[x] >: F[x], B](onFailure: (Throwable) => Lifecycle[G, B], onSuccess: (DockerContainer[Tag]) => Lifecycle[G, B])(implicit arg0: QuasiIO[G]): Lifecycle[G, B]
    Definition Classes
    Lifecycle
  39. def release(container: DockerContainer[Tag]): F[Unit]

    The action in F used to release, close or deallocate the resource after it has been acquired and used through izumi.distage.model.definition.Lifecycle.SyntaxUse#use.

    The action in F used to release, close or deallocate the resource after it has been acquired and used through izumi.distage.model.definition.Lifecycle.SyntaxUse#use.

    Definition Classes
    ContainerResource → Basic → Lifecycle
    Note

    the release action is performed *uninterruptibly*, when F is an effect type that supports interruption/cancellation.

  40. def runNew(imageName: String, imageRegistry: Option[String], registryAuth: Option[AuthConfig], ports: Seq[PortDecl]): F[DockerContainer[Tag]]
    Attributes
    protected
  41. def runReused(imageName: String, imageRegistry: Option[String], registryAuth: Option[AuthConfig], ports: Seq[PortDecl]): F[DockerContainer[Tag]]
    Attributes
    protected
  42. val stableLabels: Map[String, String]
    Attributes
    protected
  43. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  44. def toExposedPort(port: DockerPort, number: Int): ExposedPort
    Attributes
    protected
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. final def void[G[x] >: F[x]](implicit arg0: QuasiFunctor[G]): Lifecycle[G, Unit]
    Definition Classes
    Lifecycle
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def widen[B >: DockerContainer[Tag]]: Lifecycle[F, B]
    Definition Classes
    Lifecycle
    Annotations
    @inline()
  51. final def widenF[G[x] >: F[x]]: Lifecycle[G, DockerContainer[Tag]]
    Definition Classes
    Lifecycle
    Annotations
    @inline()
  52. final def wrapAcquire[G[x] >: F[x]](f: (=> G[InnerResource]) => G[InnerResource]): Lifecycle[G, DockerContainer[Tag]]

    Wrap acquire action of this resource in another effect, e.g.

    Wrap acquire action of this resource in another effect, e.g. for logging purposes

    Definition Classes
    Lifecycle
  53. final def wrapRelease[G[x] >: F[x]](f: ((InnerResource) => G[Unit], InnerResource) => G[Unit]): Lifecycle[G, DockerContainer[Tag]]

    Wrap release action of this resource in another effect, e.g.

    Wrap release action of this resource in another effect, e.g. for logging purposes

    Definition Classes
    Lifecycle

Inherited from Basic[F, DockerContainer[Tag]]

Inherited from Lifecycle[F, DockerContainer[Tag]]

Inherited from AnyRef

Inherited from Any

Ungrouped