Documentation
¶
Overview ¶
Package opendatastructures is the library behind the opendatastructures command line: the HTTP client, request shaping, and the typed data models for the Open Data Structures book at opendatastructures.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
- type Chapter
- type Client
- func (c *Client) Chapters(ctx context.Context, lang string) ([]*Chapter, error)
- func (c *Client) Get(ctx context.Context, url string) ([]byte, error)
- func (c *Client) GetPage(ctx context.Context, path string) (*Page, error)
- func (c *Client) PageLinks(ctx context.Context, path string, limit int) ([]*Page, error)
- type Domain
- type Page
Constants ¶
const BaseURL = "https://" + Host
BaseURL is the root every request is built from.
const DefaultUserAgent = "opendatastructures/dev (+https://github.com/tamnd/opendatastructures-cli)"
DefaultUserAgent identifies the client to opendatastructures.org.
const Host = "opendatastructures.org"
Host is the site this client talks to.
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 int `json:"number" csv:"number" tsv:"number"`
Title string `json:"title" csv:"title" tsv:"title"`
Lang string `json:"lang" csv:"lang" tsv:"lang"`
URL string `json:"url" csv:"url" tsv:"url"`
}
Chapter is one numbered chapter in the Open Data Structures book.
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 opendatastructures.org over HTTP.
func NewClient ¶
func NewClient() *Client
NewClient returns a Client with sensible defaults: a 30s timeout, a 500ms minimum gap between requests, and three retries on transient errors.
func (*Client) Chapters ¶
Chapters fetches the chapter list for the given language edition. lang must be one of "python", "java", "cpp". Defaults to "python".
func (*Client) Get ¶
Get fetches url and returns the response body. It paces and retries according to the client's settings.
type Domain ¶
type Domain struct{}
Domain is the opendatastructures driver. It carries no state; the per-run client is built by the factory Register hands kit.
func (Domain) Classify ¶
Classify turns any accepted input — a bare path or a full opendatastructures.com URL — into the canonical (type, id), so `ant resolve` and `ant url` touch no network.
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