-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A path within another path.
--   
--   Simple type for representing a well-typed path within another path.
--   Useful for when you need to jump between directories and change
--   filenames independently. Uses the path library.
@package within
@version 0.0.1.1

module Within

-- | The <a>Within</a> type represents a relative <a>Path</a> inside a
--   directory <a>Path</a>. The two halves can be manipulated
--   independently.
newtype Within a t
Within :: (Path a Dir, Path Rel t) -> Within a t

-- | Convert a <a>Within</a> to a <a>Path</a> by joining it with a path
--   separator.
fromWithin :: Within a t -> Path a t

-- | Convert a directory <a>Path</a> and a relative <a>Path</a> to a
--   <a>Within</a>
toWithin :: Path a Dir -> Path Rel t -> Within a t

-- | Infix version of <a>toWithin</a>, e.g "file.txt `within` myDir"
within :: Path Rel t -> Path a Dir -> Within a t

-- | Attempts to convert a <a>Path</a> to a <a>Within</a> by treating it as
--   if it were within the second argument. Used infix as
--   "myParentDir/foo/file.txt `asWithin` myParentDir"
asWithin :: MonadThrow m => Path a t -> Path a Dir -> m (Within a t)

-- | Extracts the inner path.
whatLiesWithin :: Within a t -> Path Rel t

-- | Map the inner part of the <a>Within</a> value to a new <a>Path</a>.
mapWithin :: (Path Rel s -> Path Rel t) -> Within a s -> Within a t

-- | Map the inner part of the <a>Within</a> value to a new <a>Path</a>
--   with an operation that may throw.
mapWithinT :: MonadThrow m => (Path Rel s -> m (Path Rel t)) -> Within a s -> m (Within a t)

-- | Map the outer part of a <a>Within</a> value via a function that
--   changes the directory.
moveWithin :: (Path a Dir -> Path b Dir) -> Within a t -> Within b t

-- | Map the outer part of a <a>Within</a> value via a function that
--   changes the directory with an operation that may throw.
moveWithinT :: MonadThrow m => (Path a Dir -> m (Path b Dir)) -> Within a t -> m (Within b t)

-- | Switch the outer part of a <a>Within</a> value to a new directory
--   immediately.
blinkWithin :: Path b Dir -> Within a t -> Within b t

-- | <a>moveWithinT</a> and <a>mapWithinT</a> simultaneously.
moveAndMapT :: MonadThrow m => (Path a Dir -> m (Path b Dir)) -> (Path Rel s -> m (Path Rel t)) -> Within a s -> m (Within b t)

-- | <a>blinkWithin</a> and <a>mapWithinT</a> simultaneously.
blinkAndMapT :: MonadThrow m => Path b Dir -> (Path Rel s -> m (Path Rel t)) -> Within a s -> m (Within b t)
instance GHC.Show.Show (Within.Within a t)
instance GHC.Classes.Eq (Within.Within a t)
instance GHC.Generics.Generic (Within.Within a t)