ValueLensType

PackageFCQRS.Model

Specification

Kind
Type
Members
7
Examples
0
CreateSignature
ValueLens.Create(innerValue)
CreateAsResultSignature
ValueLens.CreateAsResult(v)
IsValidValueSignature
ValueLens.IsValidValue(this)
ToStringSignature
ValueLens.ToString(this)
TryCreateSignature
ValueLens.TryCreate(innerValue)

Summary

NameSignatureSynopsis
CreateValueLens.Create(innerValue)Creates non validated parent type directly.
CreateAsResultValueLens.CreateAsResult(v)Skips first level of validation.
IsValidValueValueLens.IsValidValue(this)Reapplies validation rules, typical use case is after deserialization when you cannot trust the data.
ToStringValueLens.ToString(this)Converts inner value ToString
TryCreateValueLens.TryCreate(innerValue)Creates a Result type depending the outcome of validation.
ValueValueLens.Value(this)Gets the inner value
ValueValueLens.Value(this)Gets the inner value

Create

ValueLens.Create(innerValue)
Member
Creates non validated parent type directly.

Parameters

NameTypeDescription
innerValue'Inner

Returns

^Wrapped

CreateAsResult

ValueLens.CreateAsResult(v)
Member
Skips first level of validation.

Parameters

NameTypeDescription
v'a

Returns

Result<^b, 'd>

IsValidValue

ValueLens.IsValidValue(this)
Member
Reapplies validation rules, typical use case is after deserialization when you cannot trust the data.

Parameters

NameTypeDescription
this^Wrapped

Returns

bool

ToString

ValueLens.ToString(this)
Member
Converts inner value ToString

Parameters

NameTypeDescription
this^Wrapped

Returns

string

TryCreate

ValueLens.TryCreate(innerValue)
Member
Creates a Result type depending the outcome of validation.

Parameters

NameTypeDescription
innerValue'Inner

Returns

Result<^Wrapped, 'Error>

Value

ValueLens.Value(this)
Member
Gets the inner value

Parameters

NameTypeDescription
this^Wrapped

Returns

'Inner

Value

ValueLens.Value(this)
Member
Gets the inner value

Parameters

NameTypeDescription
this^Wrapped

Returns

'Inner