sentinel

Documentation

Overview

Package sentinel allows for the use of Unicode non-characters to distinguish between Boundary defined sentinels and values provided by external systems.

All sentinel values are prefixed with the sentinel start character U+FFFE and suffixed with the sentinel end character U+FFFF. Any string that starts with U+FFFE and ends with U+FFFF is a valid sentinel and reserved for use within Boundary.

U+FFFE and U+FFFF are special non-characters reserved for internal use in the Unicode standard. See https://www.unicode.org/versions/Unicode13.0.0/ch23.pdf#G12612.

Index

• Constants
• func Is(s string) bool

Constants

const (
	// Start is the Unicode special non-character U+FFFE, and the prefix included in all
	// Boundary defined sentinel values.
	Start = '\ufffe'

	// End is the Unicode special non-character U+FFFF, and the suffix included in all
	// Boundary defined sentinel values.
	End = '\uffff'
)

const (
	// ExternalIdNone is a Boundary sentinel indicating that no id was provided by an
	// external system.
	ExternalIdNone = "\ufffenone\uffff"
	// ErrorDetailsNone is a Boundary sentinel indicating that there were no error details.
	NoErrorDetails = "\ufffeno error details\uffff"
)

Functions

func Is

func Is(s string) bool

Is returns true if s is a valid sentinel.