FSharpx.Extras


Display Module

Functions and values

Function or value Description

any_to_layout options value

Full Usage: any_to_layout options value

Parameters:
Returns: Layout
options : FormatOptions
value : 'T
Returns: Layout

any_to_string value

Full Usage: any_to_string value

Parameters:
    value : 'T

Returns: string

Convert any value to a string using a standard formatter Data is typically formatted in a structured format, e.g. lists are formatted using the "[1;2]" notation. The details of the format are not specified and may change from version to version and according to the flags given to the F# compiler. The format is intended to be human-readable, not machine readable. If alternative generic formats are required you should develop your own formatter, using the code in the implementation of this file as a starting point. Data from other .NET languages is formatted using a virtual call to Object.ToString() on the boxed version of the input.

value : 'T
Returns: string

layout_as_string options value

Full Usage: layout_as_string options value

Parameters:
Returns: string
options : FormatOptions
value : 'T
Returns: string

layout_to_string options layout

Full Usage: layout_to_string options layout

Parameters:
Returns: string

Convert any value to a layout using the given formatting options. The layout can then be processed using formatting display engines such as those in the LayoutOps module. any_to_string and output_any are built using any_to_layout with default format options.

options : FormatOptions
layout : Layout
Returns: string

output_any writer value

Full Usage: output_any writer value

Parameters:

Ouput any value to a channel using the same set of formatting rules as any_to_string

writer : TextWriter
value : 'T

output_layout options writer layout

Full Usage: output_layout options writer layout

Parameters:
options : FormatOptions
writer : TextWriter
layout : Layout

squash_layout options layout

Full Usage: squash_layout options layout

Parameters:
Returns: Layout
options : FormatOptions
layout : Layout
Returns: Layout