smithy4s.ServiceProduct.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smithy4s-core_3 Show documentation

core

There is a newer version: 0.19.0-41-91762fb

/*
 *  Copyright 2021-2024 Disney Streaming
 *
 *  Licensed under the Tomorrow Open Source Technology License, Version 1.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     https://disneystreaming.github.io/TOST-1.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package smithy4s

import smithy4s.kinds.FunctorK5
import smithy4s.kinds.PolyFunction5

/**
  * Something that returns a product of endpoints.
  * Contains the same information as a service, with the difference that the
  * algebra (the product type parameter) can be be an interface with methods
  * without inputs.
  *
  * @tparam Prod the product type parameter. For code generation this is also
  * generated as an interface with methods without inputs (one for each
  * endpoint). This has suffix `ProductGen`.
  */
trait ServiceProduct[Prod[_[_, _, _, _, _]]] extends FunctorK5[Prod] {
  type Alg[_[_, _, _, _, _]]
  val service: Service[Alg]
  def endpointsProduct: Prod[service.Endpoint]

  def toPolyFunction[Func[_, _, _, _, _]](
      algebra: Prod[Func]
  ): PolyFunction5[service.Endpoint, Func]
}

object ServiceProduct {

  type Aux[Prod[_[_, _, _, _, _]], Algebra[_[_, _, _, _, _]]] =
    ServiceProduct[Prod] {
      type Alg[Op[_, _, _, _, _]] = Algebra[Op]
    }

  /**
  * Provides a way to get the product version for a service.
  * For info about the `Prod` type parameter, see [[ServiceProduct]].
  *
  * @tparam Alg the algebra type parameter.
  */
  trait Mirror[Alg[_[_, _, _, _, _]]] {
    type Prod[_[_, _, _, _, _]]
    val serviceProduct: ServiceProduct.Aux[Prod, Alg]
  }

  object Mirror {

    type Aux[Alg[_[_, _, _, _, _]], ProdAlg[_[_, _, _, _, _]]] =
      Mirror[Alg] {
        type Prod[Op[_, _, _, _, _]] = ProdAlg[Op]
      }

  }

}