Hoogle Search

Within LTS Haskell 24.32 (ghc-9.10.3)

Note that Stackage only displays results for the latest LTS and Nightly snapshot. Learn more.

Exact lookup

1. pHPrintStringNoColor :: MonadIO m => Handle -> String -> m ()

   pretty-simple	Text.Pretty.Simple

   Like pPrintStringNoColor, but take a Handle to determine where to print to.

   >>> pHPrintStringNoColor stdout $ show $ Just ["hello", "bye"]
   Just
   [ "hello"
   , "bye"
   ]
   

2. pHPrintStringOpt :: MonadIO m => CheckColorTty -> OutputOptions -> Handle -> String -> m ()

   pretty-simple	Text.Pretty.Simple

   Similar to pPrintStringOpt, but take a Handle to determine where to print to.

   >>> let foo = show (1, (2, "hello", 3))
   
   >>> pHPrintStringOpt CheckColorTty defaultOutputOptionsNoColor stdout foo
   ( 1
   ,
   ( 2
   , "hello"
   , 3
   )
   )
   

3. pPrint :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Pretty-print any data type that has a Show instance. If you've never seen MonadIO before, you can think of this function as having the following type signature:

   pPrint :: Show a => a -> IO ()
   

   This function will only use colors if it detects it's printing to a TTY. This function is for printing to a dark background. Use pPrintLightBg for printing to a terminal with a light background. Different colors are used. Prints to stdout. Use pHPrint to print to a different Handle.

   >>> pPrint [Just (1, "hello")]
   [ Just
   ( 1
   , "hello"
   )
   ]
   

4. pPrintDarkBg :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Alias for pPrint.

5. pPrintForceColor :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Similar to pPrint, but print in color regardless of whether the output goes to a TTY or not. See pPrint for an example of how to use this function.

6. pPrintForceColorDarkBg :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Alias for pPrintForceColor.

7. pPrintForceColorLightBg :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Just like pPrintForceColorDarkBg, but for printing to a light background.

8. pPrintLightBg :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Just like pPrintDarkBg, but for printing to a light background.

9. pPrintNoColor :: (MonadIO m, Show a) => a -> m ()

   pretty-simple	Text.Pretty.Simple

   Similar to pPrint, but doesn't print in color. However, data types will still be indented nicely.

   >>> pPrintNoColor $ Just ["hello", "bye"]
   Just
   [ "hello"
   , "bye"
   ]
   

10. pPrintOpt :: (MonadIO m, Show a) => CheckColorTty -> OutputOptions -> a -> m ()

    pretty-simple	Text.Pretty.Simple

    Similar to pPrint but takes OutputOptions to change how the pretty-printing is done. For example, pPrintOpt can be used to make the indentation much smaller than normal. This is what the normal indentation looks like:

    >>> pPrintOpt NoCheckColorTty defaultOutputOptionsNoColor $ Just ("hello", "bye")
    Just
    ( "hello"
    , "bye"
    )
    

    This is what smaller indentation looks like:

    >>> let smallIndent = defaultOutputOptionsNoColor {outputOptionsIndentAmount = 1}
    
    >>> pPrintOpt CheckColorTty smallIndent $ Just ("hello", "bye")
    Just
    ( "hello"
    , "bye"
    )
    

    Lines in strings get indented

    >>> pPrintOpt NoCheckColorTty defaultOutputOptionsNoColor (1, (2, "foo\nbar\nbaz", 3))
    ( 1
    ,
    ( 2
    , "foo
    bar
    baz"
    , 3
    )
    )
    

    Lines get indented even in custom show instances

    >>> data Foo = Foo
    
    >>> instance Show Foo where show _ = "foo\nbar\nbaz"
    
    >>> pPrintOpt CheckColorTty defaultOutputOptionsNoColor (1, (2, Foo, 3))
    ( 1
    ,
    ( 2
    , foo
    bar
    baz
    , 3
    )
    )
    

    CheckColorTty determines whether to test stdout for whether or not it is connected to a TTY. If set to NoCheckColorTty, then pPrintOpt won't check if stdout is a TTY. It will print in color depending on the value of outputOptionsColorOptions. If set to CheckColorTty, then pPrintOpt will check if stdout is conneted to a TTY. If stdout is determined to be connected to a TTY, then it will print in color depending on the value of outputOptionsColorOptions. If stdout is determined to NOT be connected to a TTY, then it will NOT print in color, regardless of the value of outputOptionsColorOptions.

Page 186 of many | Previous | Next