StepName.hs

{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE TypeOperators #-}
{-# OPTIONS_GHC -Wall #-}

{- | The name @stepName@, targeting 'String': the name of a step, such as @"pdf page 1"@.

Any value of the target type has the name, as the identity.

@since 0.8.0.0
-}
module System.FilePather.Name.StepName (
  StepNameLike (..),
) where

import Control.Lens (Optic)

{- | A field or a constructor named @stepName@.

@since 0.8.0.0
-}
class StepNameLike p f x x' where
  stepName ::
    Optic p f x x' String String

{- | Identity

@since 0.8.0.0
-}
instance (x' ~ String) => StepNameLike p f String x' where
  stepName =
    id
  {-# INLINE stepName #-}