package bidirule

Import Path
	vendor/golang.org/x/text/secure/bidirule (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	  d bidirule.go
		Package bidirule implements the Bidi Rule defined by RFC 5893.
		
		This package is under development. The API may change without notice and
		without preserving backward compatibility.

	    bidirule10.0.0.go
Package-Level Type Names (total 3, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Transformer (struct)
		Transformer implements transform.Transform.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			hasRTL bool
			seen uint16
			state ruleState
		Methods (total 7, in which 3 are exported)
			(*Transformer) Reset()
				Reset implements transform.Transformer.

			(*Transformer) Span(src []byte, atEOF bool) (n int, err error)
				Span returns the first n bytes of src that conform to the Bidi rule.

			(*Transformer) Transform(dst, src []byte, atEOF bool) (nDst, nSrc int, err error)
				Transform implements transform.Transformer. This Transformer has state and
				needs to be reset between uses.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*Transformer) advance(s []byte) (n int, ok bool)
			(*Transformer) advanceString(s string) (n int, ok bool)
			(*Transformer) isFinal() bool
			(*Transformer) isRTL() bool
				A rule can only be violated for "Bidi Domain names", meaning if one of the
				following categories has been observed.

		Implements (at least 2, both are exported)
			*Transformer : vendor/golang.org/x/text/transform.SpanningTransformer
			*Transformer : vendor/golang.org/x/text/transform.Transformer
		As Outputs Of (at least one exported)
			func New() *Transformer

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type ruleState uint8 (basic type)

		As Types Of (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			const ruleInitial
			const ruleInvalid
			const ruleLTR
			const ruleLTRFinal
			const ruleRTL
			const ruleRTLFinal

	 type ruleTransition (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			mask uint16
			next ruleState


Package-Level Functions (total 6, in which 5 are exported)

	 func Direction(b []byte) bidi.Direction
		Direction reports the direction of the given label as defined by RFC 5893.
		The Bidi Rule does not have to be applied to labels of the category
		LeftToRight.

	 func DirectionString(s string) bidi.Direction
		DirectionString reports the direction of the given label as defined by RFC
		5893. The Bidi Rule does not have to be applied to labels of the category
		LeftToRight.

	 func New() *Transformer
		New returns a Transformer that verifies that input adheres to the Bidi Rule.

	 func Valid(b []byte) bool
		Valid reports whether b conforms to the BiDi rule.

	 func ValidString(s string) bool
		ValidString reports whether s conforms to the BiDi rule.

	/* one unexported ... *//* one unexported: */
	 func init()
Package-Level Variables (total 3, in which 1 is exported)

	  var ErrInvalid error
		ErrInvalid indicates a label is invalid according to the Bidi Rule.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var asciiTable [128]bidi.Properties
		Precomputing the ASCII values decreases running time for the ASCII fast path
		by about 30%.

	  var transitions [6][2]ruleTransition
Package-Level Constants (total 7, none are exported)

	/* 7 unexporteds ... *//* 7 unexporteds: */
	const exclusiveRTL uint16 = 36
		[2.4] In an RTL label, if an EN is present, no AN may be present, and
		vice versa.

	const ruleInitial ruleState = 0
	const ruleInvalid ruleState = 5
	const ruleLTR ruleState = 1
	const ruleLTRFinal ruleState = 2
	const ruleRTL ruleState = 3
	const ruleRTLFinal ruleState = 4

The pages are generated with Golds v0.6.7. (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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.