Header menu logo Xanthos

RunnerId Module

Functions for creating and working with RunnerId values.

Functions and values

Function or value Description

create value

Full Usage: create value

Parameters:
    value : string - The runner identifier string.

Returns: Result<RunnerId, XanthosError> Ok(RunnerId) if valid, Error with validation message if invalid.

Creates a RunnerId with validation.

Validation rules: - Must not be empty or whitespace - Must contain only digits (blood registration number is numeric) - Must be exactly 10 characters (standard blood registration number length)

value : string

The runner identifier string.

Returns: Result<RunnerId, XanthosError>

Ok(RunnerId) if valid, Error with validation message if invalid.

unsafe value

Full Usage: unsafe value

Parameters:
    value : string - The runner identifier string (must be valid).

Returns: RunnerId A RunnerId wrapping the given value.

Creates a RunnerId without validation. Use only for trusted input.

value : string

The runner identifier string (must be valid).

Returns: RunnerId

A RunnerId wrapping the given value.

value arg1

Full Usage: value arg1

Parameters:
Returns: string The raw string identifier.

Extracts the underlying string value from a RunnerId.

arg0 : RunnerId
Returns: string

The raw string identifier.

Type something to start searching.