Highlighter

Documentation

Index

• type NormalText
  • func NewNormalText(data []byte, style tcell.Style) *NormalText
  • func (hd *NormalText) Runes() []rune
• type Texter
• type ValidText
  • func NewValidText[T gr.TokenTyper](tokens []*gr.Token[T]) (*ValidText[T], error)

Types

type NormalText

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

NormalText is a highlighted text.

func NewNormalText

func NewNormalText(data []byte, style tcell.Style) *NormalText

NewNormalText creates a new highlighted data.

Parameters:

• data: The data to create the highlighted data from.
• style: The style to apply.

Returns:

• *NormalText: The new highlighted data.

func (*NormalText) Runes

func (hd *NormalText) Runes() []rune

Runes returns the runes of the text.

Returns:

• []rune: The runes of the text.

type Texter

type Texter interface {
}

Texter is a text.

type ValidText

type ValidText[T gr.TokenTyper] struct {
	// contains filtered or unexported fields
}

ValidText is a highlighted text.

func NewValidText

func NewValidText[T gr.TokenTyper](tokens []*gr.Token[T]) (*ValidText[T], error)

NewValidText creates a new highlighted data.

Parameters:

• tokens: The tokens to create the highlighted data from.

Returns:

• *ValidText: The new highlighted data.
• error: An error of type *uc.ErrInvalidParameter if the tokens are empty.