Logo fantomas

RichText Module

Functions and values

Function or value Description

append left right

Full Usage: append left right

Parameters:
Returns: RichText

Concatenates two texts

left : RichText
right : RichText
Returns: RichText

collectParts mapping text

Full Usage: collectParts mapping text

Parameters:
Returns: RichText

Replaces every part with zero or more parts, e.g. to split parts containing line breaks

mapping : TaggedText -> TaggedText[]
text : RichText
Returns: RichText

concat texts

Full Usage: concat texts

Parameters:
Returns: RichText

Concatenates any number of texts

texts : RichText seq
Returns: RichText

concatWith separator texts

Full Usage: concatWith separator texts

Parameters:
Returns: RichText

Concatenates any number of texts, inserting a separator between them

separator : RichText
texts : RichText seq
Returns: RichText

empty

Full Usage: empty

Returns: RichText

Text with no parts

Returns: RichText

mkActivePatternCase text

Full Usage: mkActivePatternCase text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkActivePatternResult text

Full Usage: mkActivePatternResult text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkAlias text

Full Usage: mkAlias text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkClass text

Full Usage: mkClass text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkDelegate text

Full Usage: mkDelegate text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkEnum text

Full Usage: mkEnum text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkEvent text

Full Usage: mkEvent text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkField text

Full Usage: mkField text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkFunction text

Full Usage: mkFunction text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkInterface text

Full Usage: mkInterface text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkKeyword text

Full Usage: mkKeyword text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkLineBreak text

Full Usage: mkLineBreak text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkLocal text

Full Usage: mkLocal text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkMember text

Full Usage: mkMember text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkMethod text

Full Usage: mkMethod text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkModule text

Full Usage: mkModule text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkModuleBinding text

Full Usage: mkModuleBinding text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkNamespace text

Full Usage: mkNamespace text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkNumericLiteral text

Full Usage: mkNumericLiteral text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkOperator text

Full Usage: mkOperator text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkParameter text

Full Usage: mkParameter text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkProperty text

Full Usage: mkProperty text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkPunctuation text

Full Usage: mkPunctuation text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkRecord text

Full Usage: mkRecord text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkRecordField text

Full Usage: mkRecordField text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkSpace text

Full Usage: mkSpace text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkStringLiteral text

Full Usage: mkStringLiteral text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkStruct text

Full Usage: mkStruct text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkText text

Full Usage: mkText text

Parameters:
    text : string

Returns: RichText

Creates text from a single part with the classification the name says, for the classifications a diagnostic message uses. mkText is unclassified text, i.e. text with nothing in it to classify. Prefer computing the classification from what is being named, as richTextOfEntityRefName and richTextOfValName do, over choosing one of these by hand.

text : string
Returns: RichText

mkTypeParameter text

Full Usage: mkTypeParameter text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkUnion text

Full Usage: mkUnion text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkUnionCase text

Full Usage: mkUnionCase text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkUnknownEntity text

Full Usage: mkUnknownEntity text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkUnknownType text

Full Usage: mkUnknownType text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

mkUnresolvedName text

Full Usage: mkUnresolvedName text

Parameters:
    text : string

Returns: RichText
text : string
Returns: RichText

ofParts parts

Full Usage: ofParts parts

Parameters:
Returns: RichText

Creates text from already tagged parts

parts : TaggedText[]
Returns: RichText

ofQualifiedName leafOfName name

Full Usage: ofQualifiedName leafOfName name

Parameters:
    leafOfName : string -> RichText
    name : string

Returns: RichText

A dotted name, classifying the namespace and the dots, and the name itself with the given constructor. For names that arrive from metadata, reflection or a type provider as one string; not for an assembly-qualified name, since an assembly version has dots in it too.

leafOfName : string -> RichText
name : string
Returns: RichText

ofQualifiedTypeName name

Full Usage: ofQualifiedTypeName name

Parameters:
    name : string

Returns: RichText

A dotted type name whose kind is not known, e.g. because the type could not be dereferenced

name : string
Returns: RichText

ofTag tag text

Full Usage: ofTag tag text

Parameters:
Returns: RichText

Creates text from a single part with the given classification. Text that is empty has no parts, so that where a part boundary falls is never visible in the result.

tag : TextTag
text : string
Returns: RichText

ofTaggedText part

Full Usage: ofTaggedText part

Parameters:
Returns: RichText

Creates text from a single tagged part

part : TaggedText
Returns: RichText

Type something to start searching.