resourcename

Documentation

Overview

Package resourcename implements simple functions to manipulate UTF-8 encoded AIP resource names.

Index

• Constants
• func ContainsWildcard(name string) bool
• func HasParent(name, parent string) bool
• func Match(pattern, name string) bool
• func Sprint(pattern string, variables ...string) string
• func Sscan(name, pattern string, variables ...*string) error
• type Literal
  • func (l Literal) HasRevision() bool
  • func (l Literal) ResourceID() string
  • func (l Literal) RevisionID() string
• type Scanner
  • func (s *Scanner) Full() bool
  • func (s *Scanner) Init(name string)
  • func (s *Scanner) Scan() bool
  • func (s *Scanner) Segment() Segment
  • func (s *Scanner) ServiceName() string
• type Segment
  • func (s Segment) IsVariable() bool
  • func (s Segment) IsWildcard() bool
  • func (s Segment) Literal() Literal

Constants

const RevisionSeparator = '@'

RevisionSeparator is the separator character used to separate resource IDs from revision IDs.

Functions

func ContainsWildcard

func ContainsWildcard(name string) bool

ContainsWildcard reports whether the specified resource name contains any wildcard segments.

func HasParent

func HasParent(name, parent string) bool

HasParent tests whether name has the specified parent. Wildcard segments (-) are considered.

func Match

func Match(pattern, name string) bool

Match reports whether the specified resource name matches the specified resource name pattern.

func Sprint

func Sprint(pattern string, variables ...string) string

Sprint formats resource name variables according to a pattern and returns the resulting string.

func Sscan

func Sscan(name, pattern string, variables ...*string) error

Sscan scans a resource name, storing successive segments into successive variables as determined by the provided pattern.

Types

type Literal

type Literal string

Literal is the literal part of a resource name segment.

EBNF

Literal  = RESOURCE_ID | RevisionLiteral ;
RevisionLiteral = RESOURCE_ID "@" REVISION_ID ;

func (Literal) HasRevision

func (l Literal) HasRevision() bool

HasRevision returns true if the literal has a valid revision.

func (Literal) ResourceID

func (l Literal) ResourceID() string

ResourceID returns the literal's resource ID.

func (Literal) RevisionID

func (l Literal) RevisionID() string

RevisionID returns the literal's revision ID.

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

Scanner scans a resource name.

func (*Scanner) Full

func (s *Scanner) Full() bool

Full returns true if the scanner has detected a full resource name.

func (*Scanner) Init

func (s *Scanner) Init(name string)

Init initializes the scanner.

func (*Scanner) Scan

func (s *Scanner) Scan() bool

Scan to the next segment.

func (*Scanner) Segment

func (s *Scanner) Segment() Segment

Segment returns the current segment.

func (*Scanner) ServiceName

func (s *Scanner) ServiceName() string

ServiceName returns the service name, when the scanner has detected a full resource name.

type Segment

type Segment string

Segment is a segment of a resource name or a resource name pattern.

EBNF

Segment  = Literal | Variable ;
Variable = "{" Literal "}" ;

func (Segment) IsVariable

func (s Segment) IsVariable() bool

IsVariable reports whether the segment is a variable segment.

func (Segment) IsWildcard

func (s Segment) IsWildcard() bool

IsWildcard reports whether the segment is a wildcard.

func (Segment) Literal

func (s Segment) Literal() Literal

Literal returns the literal value of the segment. For variables, the literal value is the name of the variable.