rt

Documentation

Overview

runtime globals and utilities.

Index

• Constants
• Variables
• func Click(el *Element, which InputMouseButton, count int)
• func ClosePage(page *Page) error
• func GetAttribute(el *Element, att string) string
• func GetElemText(elem *Element) string
• func GetPageText(page *Page) string
• func GetText(el *Element) string
• func Input(el *Element, txt string)
• func InputFrom(css string, txt string, pageOrElement Elementer)
• func MustSerialize(a any) string
• func NewSelectAllIterator[T Elementer](ctx context.Context, pageOrElement T, css string, limit int, xpath bool) *selectAllIteratorP
• func Pages() ([]any, error)
• func SafeSprintf(format string, a ...any) (result string, err error)
• func Serialize(a any) (string, error)
• func SetBrowserDataDir(dir string) (err error)
• func SetHeadless(h bool) error
• func SetIgnore(patt ...string) error
• type Browser
  • func GetBrowser() *Browser
• type Element
• type Elementer
• type Elements
• type Hash
  • func HashGSC(a any) (Hash, error)
• type InputMouseButton
• type Iterator
  • func NewForLoopIterator(from, to, step int) Iterator[int]
  • func NewForLoopIteratorSafe(from, to, step int) Iterator[int]
• type Page
  • func GetPage(ctx context.Context, url string) *Page
• type Unique
  • func (u *Unique) Add(a any) error

Constants

const (
	MouseLeft   = InputMouseButton(proto.InputMouseButtonLeft)
	MouseRight  = InputMouseButton(proto.InputMouseButtonRight)
	MouseMiddle = InputMouseButton(proto.InputMouseButtonMiddle)
)

Variables

var (
	ErrNotUnique = fmt.Errorf("value is not unique")
	ErrNilFilter = fmt.Errorf("cannot use a nil Unique filter")
)

var Errorf func(format string, args ...any)

Set these hooks to capture runtime errors orlog messages. If not set, will report to stdout.

var Logf func(format string, args ...any)

var SLOW_DELAY = 1 * time.Second

Default duration when SLOW is requested with invalid millis expression. Can be adjusted before running a request calling SLOW. Use for debugging only.

Functions

func Click

func Click(el *Element, which InputMouseButton, count int)

Click on an element. Use which to choose from "left", "right" or "middle" (default left). Use count to specify number of clicks (defaults 1).

func ClosePage

func ClosePage(page *Page) error

close page, set page pointer to nil on success.

func GetAttribute

func GetAttribute(el *Element, att string) string

Retrieve attribute from element. Return empty string on error.

func GetElemText

func GetElemText(elem *Element) string

Get text for element. Never wait, never fail. Return "" if error.

func GetPageText

func GetPageText(page *Page) string

Return string content of the html element in page, or "" if error. Never abort, never wait.

func GetText

func GetText(el *Element) string

Retrieve text from a *rod.Element. Return empty string if not found.

func Input

func Input(el *Element, txt string)

Input a txt in an element, after selecting and focusing on it.

func InputFrom

func InputFrom(css string, txt string, pageOrElement Elementer)

Select an element and input a txt in it.

func MustSerialize

func MustSerialize(a any) string

See Serialize. Panic on error.

func NewSelectAllIterator

func NewSelectAllIterator[T Elementer](ctx context.Context, pageOrElement T, css string, limit int, xpath bool) *selectAllIteratorP

func Pages

func Pages() ([]any, error)

Get the array of opened pages. Note : returns a GSC array ([]any), not a []*rod.Page array.

func SafeSprintf

func SafeSprintf(format string, a ...any) (result string, err error)

SafePrintf is like Sprintf, but return runtime formatting errors without panic

func Serialize

func Serialize(a any) (string, error)

Serialize a value to string, using the GSC syntax. Only values produced by GSC itself can be serialized. Maps keys are sorted to guarantee determistic serialization. Non recognized values will trigger an error.

func SetBrowserDataDir

func SetBrowserDataDir(dir string) (err error)

The directory to save brawser internal states into (cookies, etc ...)

func SetHeadless

func SetHeadless(h bool) error

Set browser in headless mode. Browser should not have started already.

func SetIgnore

func SetIgnore(patt ...string) error

Which requests patterns will always be ignored. Eg : ".jpeg", ".png", ...

Types

type Browser

type Browser = rod.Browser

defining type alias to decouple from actual driver.

func GetBrowser

func GetBrowser() *Browser

Threadsafe and lazy access to the browser singleton.

type Element

type Element = rod.Element

defining type alias to decouple from actual driver.

type Elementer

type Elementer interface {
	Elements(string) (Elements, error)
	ElementsX(string) (Elements, error)
	Element(string) (*Element, error)
	ElementX(string) (*Element, error)
}

Elementer can provide Elements or Element. Typically, a page or an element.

type Elements

type Elements = rod.Elements

defining type alias to decouple from actual driver.

type Hash

type Hash [md5.Size]byte

Hash type (an array, not a slice)

func HashGSC

func HashGSC(a any) (Hash, error)

Compute the Hash of any GSC serializable value. Error if a cannot be GSC-serializable.

type InputMouseButton

type InputMouseButton = proto.InputMouseButton

defining type alias to decouple from actual driver.

type Iterator

type Iterator[T any] interface {
	Next() (next T, ok bool)
}

Generic iterator interface

func NewForLoopIterator

func NewForLoopIterator(from, to, step int) Iterator[int]

No enforcing on dangerous values, such as step = 0. May loop forever. It is not a bug, but a feature ;-).

func NewForLoopIteratorSafe

func NewForLoopIteratorSafe(from, to, step int) Iterator[int]

Same, but adjusts provided values to ensure no endless loops and positive direction.

type Page

type Page = rod.Page

defining type alias to decouple from actual driver.

func GetPage

func GetPage(ctx context.Context, url string) *Page

Get a new page. Use empty string for empty page. Browser is started if not already available.

type Unique

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

Uniqueness filter, using a GSC Hash. Use u := new(Unique) to initialize it. Typically for RETURN DISTINCT. For rod.Element, you may prefer using element.Equal(element) to comprare actual DOM elements in browser.

func (*Unique) Add

func (u *Unique) Add(a any) error

Add a value to the uniqueness filter. Return error if value was already there, or cannot be serialized.