FSharpx.Extras


Display

Namespace: Microsoft.FSharp.Text.StructuredFormat

Functions and values

Function or valueDescription
any_to_layout options value
Signature: options:FormatOptions -> value:'T -> Layout
Type parameters: 'T
any_to_string value
Signature: value:'T -> string
Type parameters: 'T

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.

layout_as_string options value
Signature: options:FormatOptions -> value:'T -> string
Type parameters: 'T
layout_to_string options layout
Signature: options:FormatOptions -> layout:Layout -> 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. anytostring and outputany are built using anyto_layout with default format options.

output_any writer value
Signature: writer:TextWriter -> value:'T -> unit
Type parameters: 'T

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

output_layout options writer layout
Signature: options:FormatOptions -> writer:TextWriter -> layout:Layout -> unit
squash_layout options layout
Signature: options:FormatOptions -> layout:Layout -> Layout
Fork me on GitHub