Documentation
¶
Overview ¶
Package yamlchar contains functions related to YAML characters and keywords specification.
Index ¶
- Constants
- func AreHexDigits(runes ...rune) bool
- func ConformsCharSet(s string, cst CharSetType) bool
- func ConvertFromYAMLDoubleQuotedString(s string) (string, error)
- func ConvertFromYAMLSingleQuotedString(s string) (string, error)
- func ConvertToYAMLDoubleQuotedString(s string) (string, error)
- func ConvertToYAMLSingleQuotedString(s string) (string, error)
- func IsASCIILetter(r rune) bool
- func IsAnchorString(s string) bool
- func IsBlankChar(r rune) bool
- func IsDecimal(s string) bool
- func IsDigit(r rune) bool
- func IsDoubleQuotedString(s string) bool
- func IsEscapedCharacter(runes []rune, i int) (int, bool)
- func IsFlowIndicatorChar(r rune) bool
- func IsHexDigit(r rune) bool
- func IsJSONChar(r rune) bool
- func IsLineBreakChar(r rune) bool
- func IsPlainSafeString(s string) bool
- func IsSingleQuotedString(s string) bool
- func IsTagString(s string) bool
- func IsURI(s string) bool
- func IsWhitespaceChar(r rune) bool
- func IsWord(s string) bool
- type CharSetType
- type Character
Constants ¶
const ( // YAMLDirective represents a YAML directive keyword "YAML". YAMLDirective = "YAML" // TagDirective represents a YAML directive keyword "TAG". TagDirective = "TAG" )
Variables ¶
This section is empty.
Functions ¶
func AreHexDigits ¶
AreHexDigits checks if given runes are hex digits
func ConformsCharSet ¶
func ConformsCharSet(s string, cst CharSetType) bool
ConformsCharSet checks if given string consists of and follows the rules of provided CharSetType
func ConvertFromYAMLDoubleQuotedString ¶
ConvertFromYAMLDoubleQuotedString 'unquotes' double quoted YAML string
func ConvertFromYAMLSingleQuotedString ¶
ConvertFromYAMLSingleQuotedString 'unquotes' single quoted YAML string
func ConvertToYAMLDoubleQuotedString ¶
ConvertToYAMLDoubleQuotedString 'quotes' given string as YAML double quoted string
func ConvertToYAMLSingleQuotedString ¶
ConvertToYAMLSingleQuotedString 'quotes' given string as YAML single quoted string
func IsASCIILetter ¶
IsASCIILetter checks if given rune is ASCII letter (a-z or A-Z)
func IsDecimal ¶
IsDecimal checks if given string represents a decimal number (i.e. consists only of decimal digits)
func IsDoubleQuotedString ¶
YAML specification: [107] nb-double-char
func IsEscapedCharacter ¶
IsEscapedCharacter checks if given runes are valid escaped sequence of characters in YAML (i.e. \<valid single escaped character>, \x<two hex digits>, \u<four hex digits> or \U<eight hex digits>)
func IsFlowIndicatorChar ¶
YAML specification: [23] c-flow-indicator
func IsLineBreakChar ¶
IsLineBreakChar checks if given rune is either LF or CR character.
func IsPlainSafeString ¶
YAML specification: [129] ns-plain-safe-in
func IsSingleQuotedString ¶
YAML specification: [118] nb-single-char
func IsWhitespaceChar ¶
IsWhitespaceChar checks if given rune is either space or tab
Types ¶
type CharSetType ¶
type CharSetType int16
CharSetType defines a limited set of characters used in YAML specification definitions.
const ( // DecimalCharSetType corresponds to [35] ns-dec-digit of YAML specification DecimalCharSetType CharSetType = 1 << iota // WordCharSetType corresponds to [38] ns-word-char of YAML specification WordCharSetType // URICharSetType corresponds to [39] ns-uri-char of YAML specification URICharSetType // TagCharSetType corresponds to [40] ns-tag-char of YAML specification TagCharSetType // AnchorCharSetType corresponds to [102] ns-anchor-char of YAML specification AnchorCharSetType // PlainSafeCharSetType corresponds to [129] ns-plain-safe-in of YAML specification PlainSafeCharSetType // SingleQuotedCharSetType corresponds to [119] ns-single-char of YAML specification SingleQuotedCharSetType // DoubleQuotedCharSetType corresponds to [108] ns-double-char of YAML specification DoubleQuotedCharSetType )
const (
UnknownCharSetType CharSetType = 0
)
type Character ¶
type Character = rune
Character represents a single YAML character
const ( SequenceEntryCharacter Character = '-' MappingKeyCharacter Character = '?' MappingValueCharacter Character = ':' CollectEntryCharacter Character = ',' SequenceStartCharacter Character = '[' SequenceEndCharacter Character = ']' MappingStartCharacter Character = '{' MappingEndCharacter Character = '}' CommentCharacter Character = '#' AnchorCharacter Character = '&' AliasCharacter Character = '*' TagCharacter Character = '!' LiteralCharacter Character = '|' FoldedCharacter Character = '>' SingleQuoteCharacter Character = '\'' DoubleQuoteCharacter Character = '"' DirectiveCharacter Character = '%' ReservedAtCharacter Character = '@' ReservedBackquoteCharacter Character = '`' LineFeedCharacter Character = '\n' CarriageReturnCharacter Character = '\r' SpaceCharacter Character = ' ' TabCharacter Character = '\t' EscapeCharacter Character = '\\' DotCharacter Character = '.' ByteOrderMarkCharacter Character = 0xFEFF DirectiveEndCharacter Character = '-' StripChompingCharacter Character = '-' KeepChompingCharacter Character = '+' DocumentEndCharacter Character = '.' )
Source Files