System.Console.Terminal.Size · terminal-size-0.3.4

datadata Window a

Terminal window width and height

Constructors

Window
- height :: !a
- width :: !a

Instances11Functor, Foldable, Traversable, Generic1, Eq, Data, …

Functor WindowDefined in terminal-size-0.3.4 · System.Console.Terminal.Common
Foldable WindowDefined in terminal-size-0.3.4 · System.Console.Terminal.Common
Traversable WindowDefined in terminal-size-0.3.4 · System.Console.Terminal.Common
Generic1 WindowDefined in terminal-size-0.3.4 · System.Console.Terminal.Common
Eq a => Eq (Window a)Defined in terminal-size-0.3.4 · System.Console.Terminal.Common
Data a => Data (Window a)Defined in terminal-size-0.3.4 · System.Console.Terminal.Common
Read a => Read (Window a)Defined in terminal-size-0.3.4 · System.Console.Terminal.Common
Show a => Show (Window a)Defined in terminal-size-0.3.4 · System.Console.Terminal.Common
Generic (Window a)Defined in terminal-size-0.3.4 · System.Console.Terminal.Common
type Rep (Window a) = D1 ('MetaData "Window" "System.Console.Terminal.Common" "terminal-size-0.3.4-8cEyZL3Jiyc2r9gEkfvHXQ" 'False) (C1 ('MetaCons "Window" 'PrefixI 'True) (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))Defined in terminal-size-0.3.4 · System.Console.Terminal.Common
type Rep1 Window = D1 ('MetaData "Window" "System.Console.Terminal.Common" "terminal-size-0.3.4-8cEyZL3Jiyc2r9gEkfvHXQ" 'False) (C1 ('MetaCons "Window" 'PrefixI 'True) (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) Par1 :*: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) Par1))Defined in terminal-size-0.3.4 · System.Console.Terminal.Common

valuesize :: Integral n => IO (Maybe (Window n))

Get terminal window width and height for stdout.

Example2 expressions

>>> import System.Console.Terminal.Size>>> sizeJust (Window {height = 60, width = 112})

valuefdSize :: Integral n => Fd -> IO (Maybe (Window n))

Not available on Windows: Get terminal window width and height for a specified file descriptor. If it's not attached to a terminal then Nothing is returned.

Example5 expressions

>>> import System.Console.Terminal.Size>>> import System.Posix>>> fdSize stdOutputJust (Window {height = 56, width = 85})>>> fd <- openFd "foo" ReadWrite (Just stdFileMode) defaultFileFlags>>> fdSize fdNothing

valuehSize :: Integral n => Handle -> IO (Maybe (Window n))

Same as fdSize, but takes Handle instead of Fd (file descriptor).

Note that on Windows with shells that use the native console API (cmd.exe, PowerShell) this works only for output handles like stdout and stderr; for input handles like stdin it always returns Nothing.

Example3 expressions

>>> import System.Console.Terminal.Size>>> import System.IO>>> hSize stdoutJust (Window {height = 56, width = 85})