io.circe.yaml.common.Parser.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of circe-yaml-common_sjs1_2.13 Show documentation

Common interface for circe-yaml.

The newest version!

/*
 * Copyright 2016 circe
 *
 * 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 io.circe.yaml.common

import cats.data.ValidatedNel
import io.circe.Decoder
import io.circe.Error
import io.circe.Json
import io.circe.ParsingFailure

import java.io.Reader

trait Parser extends io.circe.Parser {

  /**
   * Parse YAML from the given [[Reader]], returning either [[ParsingFailure]] or [[Json]]
   *
   * @param yaml
   * @return
   */
  def parse(yaml: Reader): Either[ParsingFailure, Json]
  def parseDocuments(yaml: Reader): Stream[Either[ParsingFailure, Json]]
  def parseDocuments(yaml: String): Stream[Either[ParsingFailure, Json]]
  def decode[A: Decoder](input: Reader): Either[Error, A]
  def decodeAccumulating[A: Decoder](input: Reader): ValidatedNel[Error, A]
}

object Parser {
  // to prevent YAML at https://en.wikipedia.org/wiki/Billion_laughs_attack
  val defaultMaxAliasesForCollections: Int = 50
  val defaultCodePointLimit: Int = 3 * 1024 * 1024 // 3MB
}