FSharpx.Extras


FSharp.Text.StructuredFormat Namespace

Type/Module Description

Display

FormatOptions

A record of options to control structural formatting. For F# Interactive properties matching those of this value can be accessed via the 'fsi' value. Floating Point format given in the same format accepted by System.Double.ToString, e.g. f6 or g15. If ShowProperties is set the printing process will evaluate properties of the values being displayed. This may cause additional computation. The ShowIEnumerable is set the printing process will force the evalution of IEnumerable objects to a small, finite depth, as determined by the printing parameters. This may lead to additional computation being performed during printing. From F# Interactive the default settings can be adjusted using, for example,

   open Microsoft.FSharp.Compiler.Interactive.Settings;;
   setPrintWidth 120;;
 

IEnvironment

Joint

Data representing joints in structured layouts of terms. The representation of this data type is only for the consumption of formatting engines.

Layout

Data representing structured layouts of terms. The representation of this data type is only for the consumption of formatting engines.

LayoutOps

A layout is a sequence of strings which have been joined together. The strings are classified as words, separators and left and right parenthesis. This classification determines where spaces are inserted. A joint is either unbreakable, breakable or broken. If a joint is broken the RHS layout occurs on the next line with optional indentation. A layout can be squashed to for given width which forces breaks as required.