fs2.data.json.jq.Compiler.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fs2-data-json_2.12 Show documentation

Streaming JSON manipulation library

The newest version!

/*
 * Copyright 2024 fs2-data Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 fs2
package data
package json
package jq

import cats.{Defer, MonadThrow}

import internal.ESPJqCompiler

case class JqException(msg: String) extends Exception(msg)

/** A compiler for jq queries into some compiled form. */
trait Compiler[F[_]] {

  def compile(jq: Jq): F[Pipe[F, Token, Token]]

}

object Compiler {

  def apply[F[_]: MonadThrow: Defer]: Compiler[F] =
    new ESPJqCompiler[F]

}