Header menu logo issie

String Module

Functions and values

Function or value Description

String.DefaultComparison

Full Usage: String.DefaultComparison

Returns: StringComparison
Returns: StringComparison

String.checkIndex func comparisonType value

Full Usage: String.checkIndex func comparisonType value

Parameters:
Returns: int option
Modifiers: inline
Type parameters: 'a
func : 'a * StringComparison -> int
comparisonType : StringComparison
value : 'a
Returns: int option

String.compare strB strA

Full Usage: String.compare strB strA

Parameters:
    strB : string
    strA : string

Returns: int
strB : string
strA : string
Returns: int

String.concat sep strings

Full Usage: String.concat sep strings

Parameters:
    sep : string
    strings : string seq

Returns: string

Concatenate a sequence of strings Using sep as separator

sep : string
strings : string seq
Returns: string

String.contains value str

Full Usage: String.contains value str

Parameters:
    value : string
    str : string

Returns: bool

True if str contains value

value : string
str : string
Returns: bool

String.emptyIfNull str

Full Usage: String.emptyIfNull str

Parameters:
    str : string

Returns: string
Modifiers: inline
str : string
Returns: string

String.endsWith value str

Full Usage: String.endsWith value str

Parameters:
    value : string
    str : string

Returns: bool

True if str ends with value

value : string
str : string
Returns: bool

String.equals comparisonType value str

Full Usage: String.equals comparisonType value str

Parameters:
Returns: bool

See String.Equals

comparisonType : StringComparison
value : string
str : string
Returns: bool

String.length str

Full Usage: String.length str

Parameters:
    str : string

Returns: int
str : string
Returns: int

String.ofArray chars

Full Usage: String.ofArray chars

Parameters:
    chars : char array

Returns: string
Modifiers: inline
chars : char array
Returns: string

String.ofChar ch

Full Usage: String.ofChar ch

Parameters:
    ch : char

Returns: string
Modifiers: inline
ch : char
Returns: string

String.ofList chars

Full Usage: String.ofList chars

Parameters:
    chars : char list

Returns: string
Modifiers: inline
chars : char list
Returns: string

String.ofSeq chars

Full Usage: String.ofSeq chars

Parameters:
    chars : char seq

Returns: string
Modifiers: inline
chars : char seq
Returns: string

String.regexMatch regex str

Full Usage: String.regexMatch regex str

Parameters:
    regex : string
    str : string

Returns: string option

Match a regular expression Return Some m where m is the match string, return None on no match

regex : string
str : string
Returns: string option

String.regexMatchGroups regex str

Full Usage: String.regexMatchGroups regex str

Parameters:
    regex : string
    str : string

Returns: string list option

Match a regular expression Return Some [grps] where m is the match string, grps is the list of match groups (if any) return None on no match

regex : string
str : string
Returns: string list option

String.replace oldValue newValue str

Full Usage: String.replace oldValue newValue str

Parameters:
    oldValue : string
    newValue : string
    str : string

Returns: string

Replace all occurences of oldValue by newValue

oldValue : string
newValue : string
str : string
Returns: string

String.replaceChar oldChar newChar str

Full Usage: String.replaceChar oldChar newChar str

Parameters:
    oldChar : char
    newChar : char
    str : string

Returns: string

Replace all occurences of oldChar by newchar

oldChar : char
newChar : char
str : string
Returns: string

String.split separator str

Full Usage: String.split separator str

Parameters:
    separator : char array
    str : string

Returns: string[]

Split str at all of separator array elements Return array of strings Adjacent separators generate empty strings

separator : char array
str : string
Returns: string[]

String.splitOnWhitespace text

Full Usage: String.splitOnWhitespace text

Parameters:
    text : string

Returns: string array

splits text into its array of non-whitepace strings separated by whitespace

text : string
Returns: string array

String.splitRemoveEmptyEntries separator str

Full Usage: String.splitRemoveEmptyEntries separator str

Parameters:
    separator : char array
    str : string

Returns: string[]

Split str at all of separator array elements Return array of strings Adjacent separators do not generate strings

separator : char array
str : string
Returns: string[]

String.splitString separator str

Full Usage: String.splitString separator str

Parameters:
    separator : string array
    str : string

Returns: string[]

Split str at all of separator string array elements Return array of strings Adjacent separators generate empty strings

separator : string array
str : string
Returns: string[]

String.splitStringRemoveEmptyEntries separator str

Full Usage: String.splitStringRemoveEmptyEntries separator str

Parameters:
    separator : string array
    str : string

Returns: string[]

Split str at all of separator string array elements Return array of strings Adjacent separators do not generate strings

separator : string array
str : string
Returns: string[]

String.startsWith value str

Full Usage: String.startsWith value str

Parameters:
    value : string
    str : string

Returns: bool

Return true if str starts with value

value : string
str : string
Returns: bool

String.startsWithLetter str

Full Usage: String.startsWithLetter str

Parameters:
    str : string

Returns: bool

Return true if str starts with a letter

str : string
Returns: bool

String.substring startIndex str

Full Usage: String.substring startIndex str

Parameters:
    startIndex : int
    str : string

Returns: string

Return str from startIndex till end Throw ArgumentOutOfRange exception if startWith lies outside str

startIndex : int
str : string
Returns: string

String.substringLength startIndex length str

Full Usage: String.substringLength startIndex length str

Parameters:
    startIndex : int
    length : int
    str : string

Returns: string

Return substring of str at startIndex of length chars Throw ArgumentOutOfRange exception if any part of selected string lies outside str.

startIndex : int
length : int
str : string
Returns: string

String.toArray str

Full Usage: String.toArray str

Parameters:
    str : string

Returns: char array
Modifiers: inline
str : string
Returns: char array

String.toList str

Full Usage: String.toList str

Parameters:
    str : string

Returns: char list
Modifiers: inline
str : string
Returns: char list

String.toLower str

Full Usage: String.toLower str

Parameters:
    str : string

Returns: string
str : string
Returns: string

String.toSeq str

Full Usage: String.toSeq str

Parameters:
    str : string

Returns: char seq
Modifiers: inline
str : string
Returns: char seq

String.toUpper str

Full Usage: String.toUpper str

Parameters:
    str : string

Returns: string
str : string
Returns: string

String.trim str

Full Usage: String.trim str

Parameters:
    str : string

Returns: string

Remove all leading and training whitespace

str : string
Returns: string

String.trimChars trimChars str

Full Usage: String.trimChars trimChars str

Parameters:
    trimChars : char[]
    str : string

Returns: string

Remove all leading and trailing chars in trimChars

trimChars : char[]
str : string
Returns: string

String.trimEnd trimChars str

Full Usage: String.trimEnd trimChars str

Parameters:
    trimChars : char[]
    str : string

Returns: string

Remove all trailing whitespace

trimChars : char[]
str : string
Returns: string

String.trimStart trimChars str

Full Usage: String.trimStart trimChars str

Parameters:
    trimChars : char[]
    str : string

Returns: string

Remove all leading whitespace

trimChars : char[]
str : string
Returns: string

String.tryParseWith tryParseFunc

Full Usage: String.tryParseWith tryParseFunc

Parameters:
    tryParseFunc : string -> bool * 'T

Returns: string -> 'T option

convert a System.XXX numeric parse function to idiomatic F# option. e.g. String.TryParsewith System.Int32 will return Some n on successful Int32 parse or None.

tryParseFunc : string -> bool * 'T
Returns: string -> 'T option

Type something to start searching.