Skip to content

v0.0.1

Choose a tag to compare

@ramonrsv ramonrsv released this 30 Oct 23:18
· 35 commits to main since this release

Added

  • README.md - Comprehensive README with an overview of the crate and usage examples.
  • lib.rs - Top-level crate documentation, lint enablement, and internal re-exports.
  • docs/coding-guidelines.md - Coding guidelines that the crate should adhere to.
  • error module - An Error type and associated Result<T> for all f1_data interfaces.
  • id module - ID types for various entities, to be used uniformly across f1_data interfaces.
  • rate_limiter module - A simple rate limiter with a minimal interface required by the crate.
  • tests module - Common test utilities useful in tests across the entire crate.
  • jolpica module- Wrapper around the Jolpica F1 API.
  • /agent - The main jolpica interface, with configuration options, e.g. rate limiting, etc.
  • /api - Information about the jolpica-f1 API, e.g. rate limits, base URL, etc.
  • /concat - Functions to concatenate multi-page Responses into a single Response.
  • /get - Functions for performing GET requests to the jolpica-f1 API, including multi-page.
  • /resource - Types to identified resources and filters that can be requested from the API.
  • /response - Types that represent and deserialize JSON responses from the jolpica-f1 API.
  • /time - Types, aliases, and parsing of time/duration/date concepts/formats from jolpica-f1.
  • /tests - Utilities and assets used in tests for the jolpica module and API.
  • /tests/known_bugs - Tests for known bugs and issues, and the associated workarounds.
  • fantasy module - (Private) module, under fantasy feature, for fantasy-related data.
  • CI/CD - GitHub Actions workflow with build, test, clippy, fmt, code coverage, benchmarks, etc.
  • scripts/test_no_run_docs.sh - Scripts for testing documentation tests marked with ```no_run.
  • examples/validate_jolpica.rs - Example tool that recursively requests the whole jolpica API.
  • Benchmarks - Criterion benchmarks for GET, deserialize, Resource::to_url, etc. operations.
  • rustfmt.toml - rustfmt with max_width = 120, fn_call_width = 100.
  • TODO.md - Issue tracking, to be moved to GitHub Issues.