Documentation
¶
Overview ¶
Package rustbook is the library behind the rustbook command line: the HTTP client, request shaping, and the typed data models for the Rust Programming Language book at doc.rust-lang.org.
The Client here is the spine every command shares. It sets a real User-Agent, paces requests so a busy session stays polite, and retries the transient failures (429 and 5xx) that any public site throws under load.
Index ¶
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "rustbook/dev (+https://github.com/tamnd/rustbook-cli)"
DefaultUserAgent identifies the client to the server. A real, honest User-Agent is both polite and the thing most likely to keep you unblocked.
const Host = "doc.rust-lang.org"
Host is the site this client talks to, and the host the URI driver in domain.go claims.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Chapter ¶
type Chapter struct {
Rank int `json:"rank" csv:"rank" tsv:"rank"`
Number string `json:"number" csv:"number" tsv:"number"`
Title string `json:"title" csv:"title" tsv:"title"`
URL string `json:"url" csv:"url" tsv:"url"`
}
Chapter is one entry from the Rust book table of contents. Rank is the 1-based position in the full flat list; Number is the dotted section number like "1", "1.1", or "" for front-matter entries; Title is plain text.
type Client ¶
type Client struct {
HTTP *http.Client
UserAgent string
// Rate is the minimum gap between requests. Zero means no pacing.
Rate time.Duration
Retries int
// contains filtered or unexported fields
}
Client talks to the Rust book site over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 200ms minimum gap between requests, and five retries on transient errors.
type Domain ¶
type Domain struct{}
Domain is the rustbook driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Info ¶
func (Domain) Info() kit.DomainInfo
Info describes the scheme, the hostnames a pasted link is matched against, and the identity reused for the binary's help and version.
Source Files