Flag.scala

/*
 * Copyright (c) 2013 Functional Streams for Scala
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package fs2
package io
package file

import cats.kernel.Monoid
import fs2.io.internal.facade

final class Flag private (private[file] val bits: Long) extends AnyVal

object Flag extends FlagCompanionApi {
  private def apply(bits: Long): Flag = new Flag(bits)
  private def apply(bits: Double): Flag = Flag(bits.toLong)

  val Read = Flag(facade.fs.constants.O_RDONLY)
  val Write = Flag(facade.fs.constants.O_WRONLY)
  val Append = Flag(facade.fs.constants.O_APPEND)

  val Truncate = Flag(facade.fs.constants.O_TRUNC)
  val Create = Flag(facade.fs.constants.O_CREAT)
  val CreateNew = Flag(facade.fs.constants.O_CREAT.toLong | facade.fs.constants.O_EXCL.toLong)

  val Sync = Flag(facade.fs.constants.O_SYNC.getOrElse(0.0))
  val Dsync = Flag(facade.fs.constants.O_DSYNC.getOrElse(0.0))

  private[file] implicit val monoid: Monoid[Flag] = new Monoid[Flag] {
    override def combine(x: Flag, y: Flag): Flag = Flag(x.bits | y.bits)
    override def empty: Flag = Flag(0)
  }
}

private[file] trait FlagsCompanionPlatform {}