thumblink

Documentation

Overview

Package thumblink parses HTML and replaces links with images.

Index

• Variables
• func Join(htmlable []HTMLAble) string
• func JoinLen(a []string) int
• type HTML
  • func (l HTML) HTML() []string
  • func (l HTML) Len() int
• type HTMLAble
  • func FindLinks(input string) ([]HTMLAble, error)
• type Link
  • func (l *Link) HTML() []string
  • func (l *Link) HostMatch(test string) bool
  • func (l *Link) Len() int
  • func (l *Link) String() string
• type Mutator
• type Peekable
  • func NewPeekable(reader io.Reader, offset int) *Peekable
  • func (a *Peekable) Peeker() *Peeker
  • func (a *Peekable) PeekerOffset(offset, mode int) (*Peeker, error)
  • func (a *Peekable) Read(data []byte) (read int, err error)
• type Peeker
  • func (r *Peeker) Read(data []byte) (read int, err error)
  • func (r *Peeker) Seek(offset int64, mode int) (int64, error)
• type Prefix
  • func (p Prefix) Help() string
  • func (p Prefix) Mutate(in []HTMLAble) ([]HTMLAble, []error)
• type PrefixMutator
• type Tag
  • func (t Tag) HTML() []string
  • func (l Tag) Len() int
• type Text
  • func (t Text) HTML() []string
  • func (l Text) Len() int

Variables

var ErrSeekPastEnd = errors.New("seek past possible end of stream")

Functions

func Join

func Join(htmlable []HTMLAble) string

func JoinLen

func JoinLen(a []string) int

Types

type HTML

type HTML []string

HTML represents raw HTML. no further transforming should be done

func (HTML) HTML

func (l HTML) HTML() []string

HTML impl HTMLAble

func (HTML) Len

func (l HTML) Len() int

Len impl HTMLAble

type HTMLAble

type HTMLAble interface {
	HTML() []string
	Len() int
}

HTMLAble is a item that can be turned into HTML.

func FindLinks

func FindLinks(input string) ([]HTMLAble, error)

FindLinks traverses HTML in input, making a array of HTMLAble

type Link

type Link url.URL

Link is the url of a link

func (*Link) HTML

func (l *Link) HTML() []string

HTML impl HTMLAble

func (*Link) HostMatch

func (l *Link) HostMatch(test string) bool

HostMatch returns true if the url's host looks like *test(:port)?

func (*Link) Len

func (l *Link) Len() int

Len impl HTMLAble

func (*Link) String

func (l *Link) String() string

String call url.*URL.String()

type Mutator

type Mutator interface {
	Mutate([]HTMLAble) ([]HTMLAble, []error)
	Help() string
}

Mutators mutate HTML data

type Peekable

type Peekable struct {
	Reader io.Reader
	// contains filtered or unexported fields
}

Peekable allows you to read ahead indefinatly It will cache any Read()s made on a Peeker. Read()int on a Peekable will destroy cache as it reads. Peekers are seekable to any point cached.

func NewPeekable

func NewPeekable(reader io.Reader, offset int) *Peekable

func (*Peekable) Peeker

func (a *Peekable) Peeker() *Peeker

func (*Peekable) PeekerOffset

func (a *Peekable) PeekerOffset(offset, mode int) (*Peeker, error)

func (*Peekable) Read

func (a *Peekable) Read(data []byte) (read int, err error)

type Peeker

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

func (*Peeker) Read

func (r *Peeker) Read(data []byte) (read int, err error)

func (*Peeker) Seek

func (r *Peeker) Seek(offset int64, mode int) (int64, error)

type Prefix

type Prefix struct {
	Prefix  string
	Mutator PrefixMutator
}

func (Prefix) Help

func (p Prefix) Help() string

func (Prefix) Mutate

func (p Prefix) Mutate(in []HTMLAble) ([]HTMLAble, []error)

type PrefixMutator

type PrefixMutator interface {
	Mutate(link *Link) ([]HTMLAble, []error)
	Help() string
}

type Tag

type Tag []string

Tag represents a html tag.

func (Tag) HTML

func (t Tag) HTML() []string

HTML impl HTMLAble

func (Tag) Len

func (l Tag) Len() int

Len impl HTMLAble

type Text

type Text []string

Text represents text inside of a pair of Tags

func (Text) HTML

func (t Text) HTML() []string

HTML impl HTMLAble

func (Text) Len

func (l Text) Len() int

Len impl HTMLAble