exercism

Documentation

Overview

Package exercism fetches Exercism profile data.

Index

• func AuthRequired() bool
• func Match(urlStr string) bool
• type Client
  • func New(ctx context.Context, opts ...Option) (*Client, error)
  • func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)
• type Option
  • func WithHTTPCache(httpCache httpcache.Cacher) Option
  • func WithLogger(logger *slog.Logger) Option

Functions

func AuthRequired

func AuthRequired() bool

AuthRequired returns false because Exercism profiles are public.

func Match

func Match(urlStr string) bool

Match returns true if the URL is an Exercism profile URL.

Types

type Client

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

Client handles Exercism requests.

func New

func New(ctx context.Context, opts ...Option) (*Client, error)

New creates an Exercism client.

func (*Client) Fetch

func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)

Fetch retrieves an Exercism profile.

type Option

type Option func(*config)

Option configures a Client.

func WithHTTPCache

func WithHTTPCache(httpCache httpcache.Cacher) Option

WithHTTPCache sets the HTTP cache.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger sets a custom logger.