doodle.effect.FileWriter.scala Maven / Gradle / Ivy

Go to download

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

core

The newest version!

/*
 * Copyright 2015 Creative Scala
 *
 * 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 doodle
package effect

import cats.effect.IO
import doodle.algebra.Algebra
import doodle.algebra.Picture
import doodle.core.format.Format

import java.io.File

/** The `FileWriter` typeclass represents write a picture to a file in a given
  * format.
  */
trait FileWriter[+Alg <: Algebra, Frame, Fmt <: Format]
    extends Writer[Alg, Frame] {
  def write[A](file: File, description: Frame, picture: Picture[Alg, A]): IO[A]

  def write[A](file: File, picture: Picture[Alg, A])(using
      frame: DefaultFrame[Frame]
  ): IO[A] =
    write(file, frame.default, picture)
}