Exosphere.ATProto.RecordKey (Exosphere v0.2.0)

Copy Markdown View Source

Record Keys (rkeys).

A record key identifies an individual record within a collection in a repository. See the Record Key spec.

Syntax rules:

  • 1 to 512 characters.
  • Allowed characters: alphanumeric (A-Za-z0-9) plus ., -, _, :, ~.
  • Case-sensitive.
  • The values . and .. are explicitly disallowed.

Note: the tid record-key type (the most common) has additional constraints validated by Exosphere.ATProto.TID.valid?/1; this module validates the general record-key syntax that all rkeys must satisfy.

Examples

iex> Exosphere.ATProto.RecordKey.valid?("3jzfcijpj2z2a")
true

iex> Exosphere.ATProto.RecordKey.valid?("self")
true

iex> Exosphere.ATProto.RecordKey.valid?("..")
false

Summary

Functions

Validate a record key string.

Functions

valid?(rkey)

@spec valid?(String.t()) :: boolean()

Validate a record key string.