Header menu logo FCQRS

ValueLens Type

Static members

Static member Description

ValueLens.Create(innerValue)

Full Usage: ValueLens.Create(innerValue)

Parameters:
    innerValue : 'Inner

Returns: ^Wrapped
Modifiers: inline
Type parameters: ^Wrapped, 'Inner

Creates non validated parent type directly.

innerValue : 'Inner
Returns: ^Wrapped

ValueLens.CreateAsResult(v)

Full Usage: ValueLens.CreateAsResult(v)

Parameters:
    v : 'a

Returns: Result<^b, 'd>
Modifiers: inline
Type parameters: 'a, ^b, ^c, 'd

Skips first level of validation.

v : 'a
Returns: Result<^b, 'd>

ValueLens.IsValidValue(this)

Full Usage: ValueLens.IsValidValue(this)

Parameters:
    this : ^Wrapped

Returns: bool
Modifiers: inline
Type parameters: ^Wrapped, 'Inner, 'Error

Reapplies validation rules, typical use case is after deserialization when you cannot trust the data.

this : ^Wrapped
Returns: bool

ValueLens.Isvalid(this)

Full Usage: ValueLens.Isvalid(this)

Parameters:
    this : ^a

Returns: bool
Modifiers: inline
Type parameters: ^a, ^b, 'c, 'd, 'e

Checks if the validation rules still hold. Typical use case is after deserialization when you cannot trust the data.

this : ^a
Returns: bool

ValueLens.ToString(this)

Full Usage: ValueLens.ToString(this)

Parameters:
    this : ^Wrapped

Returns: string
Modifiers: inline
Type parameters: ^Wrapped, 'Inner

Converts inner value ToString

this : ^Wrapped
Returns: string

ValueLens.TryCreate(innerValue)

Full Usage: ValueLens.TryCreate(innerValue)

Parameters:
    innerValue : 'Inner

Returns: Result<^Wrapped, 'Error>
Modifiers: inline
Type parameters: ^Wrapped, 'Inner, 'Error

Creates a Result type depending the outcome of validation.

innerValue : 'Inner
Returns: Result<^Wrapped, 'Error>

ValueLens.Value(this)

Full Usage: ValueLens.Value(this)

Parameters:
    this : ^Wrapped

Returns: 'Inner
Modifiers: inline
Type parameters: ^Wrapped, 'Inner

Gets the inner value

this : ^Wrapped
Returns: 'Inner

ValueLens.Value(this)

Full Usage: ValueLens.Value(this)

Parameters:
    this : ^Wrapped

Returns: 'Inner
Modifiers: inline
Type parameters: ^Wrapped, 'Inner, 'Error

Gets the inner value

this : ^Wrapped
Returns: 'Inner

Type something to start searching.