Header menu logo FSharp.ATProto

RecordKey Module

Functions for creating, validating, and extracting data from RecordKey values.

Functions and values

Function or value Description

parse s

Full Usage: parse s

Parameters:
    s : string - A record key string of 1-512 characters using only [a-zA-Z0-9._~:-]. The values "." and ".." are reserved and not allowed.

Returns: Result<RecordKey, string> Ok with a validated RecordKey, or Error with a message describing the validation failure. Validation failures include: null input, reserved values ("." or ".."), or characters outside the allowed set.

Parse and validate a record key string.

s : string

A record key string of 1-512 characters using only [a-zA-Z0-9._~:-]. The values "." and ".." are reserved and not allowed.

Returns: Result<RecordKey, string>

Ok with a validated RecordKey, or Error with a message describing the validation failure. Validation failures include: null input, reserved values ("." or ".."), or characters outside the allowed set.

value arg1

Full Usage: value arg1

Parameters:
Returns: string The record key string.

Extract the string representation of a record key.

arg0 : RecordKey
Returns: string

The record key string.

Type something to start searching.