package meg

Import Path
	github.com/multiformats/go-multiaddr/x/meg (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d meg.go
		package meg implements Regular Expressions for multiaddr Components. It's short for "Megular Expressions"

	    sugar.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type CaptureFunc (func)

		As Inputs Of (at least 2)
			func CaptureWithF(code int, f CaptureFunc) Pattern
			func CaptureZeroOrMoreWithF(code int, f CaptureFunc) Pattern

	 type ListOfMatchable (interface)
		ListOfMatchable is anything list-like that contains Matchable items.
		This allows us to convert a slice of []T as a []Matchable when *T implements
		Matchable. In the future, this may not be required if Go generics allows us
		to say S ~[]T, and *T implements Matchable. This may also not be required if
		we move this out of its own package and depend on Multiaddr and Components
		directly.

		Methods (total 2)
			( ListOfMatchable) Get(i int) Matchable
			( ListOfMatchable) Len() int

	 type Matchable (interface)
		Matchable is an interface for any thing that can be matched against by this
		package. In the future, we may use multiaddr.Component types directly.

		Methods (total 4)
			( Matchable) Bytes() []byte
				Bytes() returns the underlying bytes of the matchable. For multiaddr
				Components, this includes the protocol code and possibly the varint
				encoded size.

			( Matchable) Code() int
			( Matchable) RawValue() []byte
				RawValue() returns the byte representation of the Value

			( Matchable) Value() string
				Value() returns the string representation of the matchable.

		Implemented By (at least one exported)
			*github.com/multiformats/go-multiaddr.Component
		Implements (at least one exported)
			 Matchable : github.com/apache/arrow-go/v18/internal/hashing.ByteSlice
		As Outputs Of (at least one exported)
			func ListOfMatchable.Get(i int) Matchable

	 type Matcher (struct)
		Matcher holds a graph of match state nodes. Use PatternToMatcher to create.

		Methods (only one)
			( Matcher) String() string
		Implements (at least 2)
			 Matcher : expvar.Var
			 Matcher : fmt.Stringer
		As Outputs Of (at least one exported)
			func PatternToMatcher(patterns ...Pattern) Matcher
		As Inputs Of (at least one exported)
			func Match[L](matcher Matcher, components L) (bool, error)

	 type MatchState (struct)
		MatchState is the Thompson NFA for a regular expression.

		Methods (only one)
			( MatchState) String() string
		Implements (at least 2)
			 MatchState : expvar.Var
			 MatchState : fmt.Stringer

	 type Pattern = (func)
		Pattern is a curried MatchState. Given the slice of current MatchStates and a
		handle (int index) to the next MatchState, it returns a (possibly modified)
		slice of next MatchStates and handle to the inserted MatchState.


Package-Level Functions (total 16)

	 func CaptureBytes(code int, val *[]byte) Pattern
	 func CaptureOneOrMoreBytes(code int, vals *[][]byte) Pattern
	 func CaptureOneOrMoreStrings(code int, vals *[]string) Pattern
	 func CaptureString(code int, val *string) Pattern
	 func CaptureWithF(code int, f CaptureFunc) Pattern
	 func CaptureZeroOrMoreBytes(code int, vals *[][]byte) Pattern
	 func CaptureZeroOrMoreStrings(code int, vals *[]string) Pattern
	 func CaptureZeroOrMoreWithF(code int, f CaptureFunc) Pattern
	 func Cat(patterns ...Pattern) Pattern
	 func Match[L](matcher Matcher, components L) (bool, error)

		Type Parameters:
			L: ListOfMatchable

		Match returns whether the given Components match the Matcher
		
		Errors are used to communicate capture errors.
		If the error is non-nil the returned bool will be false.
		
		Components must be a ListOfMatchable to allow us to use a slice of []T as a
		[]Matchable when *T implements Matchable.

	 func OneOrMore(code int) Pattern
	 func Optional(s Pattern) Pattern
	 func Or(p ...Pattern) Pattern
	 func PatternToMatcher(patterns ...Pattern) Matcher
	 func Val(code int) Pattern
	 func ZeroOrMore(code int) Pattern
Package-Level Variables (only one)

	  var Any int
		Any is a special code that matches any value.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.