System.IO.Resource.Linear.Internal · linear-base-0.4.0

newtypenewtype ReleaseMap

#

Constructors

ReleaseMap (IntMap (IO ()))

newtypenewtype RIO a

#

The resource-aware I/O monad. This monad guarantees that acquired resources are always released.

Constructors

RIO (IORef ReleaseMap -> IO a)

Instances7Monad, Functor, Applicative, Monoid, Semigroup, …

Applicative RIODefined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal
Functor RIODefined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal
Monad RIODefined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal
Functor RIODefined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal
Applicative RIODefined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal
Monoid a => Monoid (RIO a)Defined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal
Semigroup a => Semigroup (RIO a)Defined in linear-base-0.4.0 · System.IO.Resource.Linear.Internal

valueunRIO :: RIO a %1 -> IORef ReleaseMap -> IO a

#

valuerun :: RIO (Ur a) -> IO a

#

Take a RIO computation with a value a that is not linearly bound and make it a System.IO computation.

valueunsafeFromSystemIO :: IO a %1 -> RIO a

#

Should not be applied to a function that acquires or releases resources.

typetype Handle = Resource Handle

#

valueopenFile :: FilePath -> IOMode -> RIO Handle

#

See System.IO.System.IO.openFile

valueopenBinaryFile :: FilePath -> IOMode -> RIO Handle

#

See System.IO.System.IO.openBinaryFile

valuehClose :: Handle %1 -> RIO ()

#

Specialised alias for release

valuehIsEOF :: Handle %1 -> RIO (Ur Bool, Handle)

#

valuehGetChar :: Handle %1 -> RIO (Ur Char, Handle)

#

valuehPutChar :: Handle %1 -> Char -> RIO Handle

#

valuehGetLine :: Handle %1 -> RIO (Ur Text, Handle)

#

valuehPutStr :: Handle %1 -> Text -> RIO Handle

#

valuehPutStrLn :: Handle %1 -> Text -> RIO Handle

#

valuehSeek :: Handle %1 -> SeekMode -> Integer -> RIO Handle

#

See System.IO.System.IO.hSeek.

valuehTell :: Handle %1 -> RIO (Ur Integer, Handle)

#

See System.IO.System.IO.hTell.

datadata Resource a where

#

The type of system resources. To create and use resources, you need to use the API since the constructor is not released.

Constructors

UnsafeResource :: Int -> a -> Resource a

typetype UnsafeResource = Resource

#

Deprecated. UnsafeResource has been renamed to Resource

Deprecated alias for Resource

valuerelease :: Resource a %1 -> RIO ()

#

release r calls the release function provided when r was acquired.

valueunsafeRelease :: Resource a %1 -> RIO ()

#

Deprecated. unsafeRelease has been renamed to release

Deprecated alias of the release function

valueunsafeAcquire :: IO (Ur a) -> (a -> IO ()) -> RIO (Resource a)

#

Given a resource in the System.IO.Linear.IO monad, and given a function to release that resource, provides that resource in the RIO monad. For example, releasing a Handle from System.IO would be done with fromSystemIO hClose. Because this release function is an input, and could be wrong, this function is unsafe.

valueunsafeFromSystemIOResource

:: a -> IO b
-> Resource a
-> RIO (Ur b, Resource a)

#

Given a System.IO computation on an unsafe resource, lift it to RIO computaton on the acquired resource. That is function of type a -> IO b turns into a function of type Resource a %1-> RIO (Ur b) along with threading the Resource a.

unsafeFromSystemIOResource is only safe to use on actions which do not release the resource.

Note that the result b can be used non-linearly.

valueunsafeFromSystemIOResource_

:: a -> IO ()
-> Resource a
-> RIO (Resource a)

#

Specialised variant of unsafeFromSystemIOResource for actions that don't return a value.