NonBlankStringUnion

PackageReified.Refinements
Operations over text known to carry non-whitespace content.

Specification

Kind
Union
Members
12
Examples
0
refinementSignature
refinement
valueSignature
value input
createSignature
create value
mapSignature
map mapping input
appendSignature
append left right

Summary

NameSignatureSynopsis
Union cases
Valuethis.ValueReturns the underlying string value.
Operations
refinementrefinement No description available.
valuevalue inputReturns the underlying string value.
createcreate valueAdmits text that is not null, empty, or whitespace.
mapmap mapping inputApplies a mapping and re-admits the result, which may no longer be inhabited.
appendappend left rightConcatenates two inhabited strings.
joinjoin separator valuesConcatenates with a separator.
trimtrim inputTrims surrounding whitespace.
toUppertoUpper inputConverts to upper case.
toLowertoLower inputConverts to lower case.
lengthlength inputReturns the length as a plain int, matching String.length.
splitsplit separator inputSplits on a separator, discarding blank segments.

Union cases

kind:member

Value

this.Value
Member
Returns the underlying string value.

Returns

string

Operations

kind:member

refinement

refinement
Member

Returns

Refinement<string, NonBlankString>
kind:member

value

value input
Member
Returns the underlying string value.

Parameters

NameTypeDescription
inputNonBlankString

Returns

string
kind:member

create

create value
Member
Admits text that is not null, empty, or whitespace.

Parameters

NameTypeDescription
valuestring

Returns

Result<NonBlankString, Violation>
kind:member

map

map mapping input
Member
Applies a mapping and re-admits the result, which may no longer be inhabited.

Parameters

NameTypeDescription
mappingstring -> string
inputNonBlankString

Returns

Result<NonBlankString, Violation>
kind:member

append

append left right
Member
Concatenates two inhabited strings. Total — the result is still inhabited.

Parameters

NameTypeDescription
leftNonBlankString
rightNonBlankString

Returns

NonBlankString
kind:member

join

join separator values
Member
Concatenates with a separator. Total.

Parameters

NameTypeDescription
separatorstring
valuesNonEmptyList<NonBlankString>

Returns

NonBlankString
kind:member

trim

trim input
Member
Trims surrounding whitespace. Total — trimming inhabited text leaves it inhabited.

Parameters

NameTypeDescription
inputNonBlankString

Returns

NonBlankString
kind:member

toUpper

toUpper input
Member
Converts to upper case. Total.

Parameters

NameTypeDescription
inputNonBlankString

Returns

NonBlankString
kind:member

toLower

toLower input
Member
Converts to lower case. Total.

Parameters

NameTypeDescription
inputNonBlankString

Returns

NonBlankString
kind:member

length

length input
Member
Returns the length as a plain int, matching String.length.

Parameters

NameTypeDescription
inputNonBlankString

Returns

int
kind:member

split

split separator input
Member
Splits on a separator, discarding blank segments. Returns a non-empty list because inhabited text always yields at least one inhabited segment.

Parameters

NameTypeDescription
separatorstring
inputNonBlankString

Returns

NonEmptyList<NonBlankString>