Header menu logo TDesu.FSharp

NonEmptyString Module

Operations on NonEmptyString.

Functions and values

Function or value Description

NonEmptyString.create s

Full Usage: NonEmptyString.create s

Parameters:
    s : string

Returns: Result<NonEmptyString, NonEmptyStringError>

Create a NonEmptyString from a raw string. Returns Error if null or whitespace. The raw string to validate and wrap.

s : string
Returns: Result<NonEmptyString, NonEmptyStringError>

NonEmptyString.createOrFail s

Full Usage: NonEmptyString.createOrFail s

Parameters:
    s : string

Returns: NonEmptyString

Create a NonEmptyString, throwing if invalid. The raw string to validate and wrap.

s : string
Returns: NonEmptyString

NonEmptyString.length arg1

Full Usage: NonEmptyString.length arg1

Parameters:
Returns: int

String length. The NonEmptyString to measure.

arg0 : NonEmptyString
Returns: int

NonEmptyString.value arg1

Full Usage: NonEmptyString.value arg1

Parameters:
Returns: string

Extract the underlying string value. The NonEmptyString to unwrap.

arg0 : NonEmptyString
Returns: string

Type something to start searching.