Expand description
Canonical league-data schema, data-provider WIT interface, and plugin manifest format
shared by the FullTime plugin host and every data-provider plugin.
Neither the host nor any plugin owns this contract: it is versioned and published
independently of both so the host and plugins can evolve without a lockstep release.
See openspec/changes/define-league-data-contract/proposal.md for the full rationale.
§Examples
use fulltime_plugin_api::{Manifest, SCHEMA_VERSION};
let source = include_str!("../tests/fixtures/manifest.toml");
let manifest = Manifest::parse(source)?;
assert!(SCHEMA_VERSION.accepts(manifest.schema_version));Modules§
Macros§
- export
- Generates
#[unsafe(no_mangle)]functions to export the specified type as the root implementation of all generated traits.
Structs§
- Competition
- A competition (league, cup, or tournament).
- Fixture
- A scheduled or completed match, covering both single-table league fixtures and group-stage/knockout fixtures using the same shape.
- Manifest
- A parsed plugin manifest.
- Network
Failure - A plugin’s upstream HTTP call failed at the network layer.
- Parse
Version Error - Error returned when parsing a
Versionfrom a string fails. - Rate
Limited - A plugin’s upstream source responded with a rate-limit error.
- Schema
Mapping Failure - A plugin received upstream data it could not map to the canonical schema.
- Score
- Final or in-progress score for a fixture.
- Standings
- Standings for a competition, as one or more groups sharing the same row shape.
- Standings
Group - One ranked table, optionally named (e.g. “Group A”) for group-based formats. A single-table league format has exactly one unnamed group.
- Standings
Row - One row of a standings table.
- Team
- A team taking part in one or more competitions.
- Version
- A
major.minorversion identifier for either the canonical schema or the data-provider interface.
Enums§
- Fixture
Status - Lifecycle state of a fixture.
- Manifest
Error - Error returned when a manifest fails to parse.
- Manifest
Field - A manifest field that failed presence or format validation.
- Provider
Error - The error a data-provider operation returns on failure.
Constants§
- INTERFACE_
VERSION - Current version of the
data-providerWIT interface. - SCHEMA_
VERSION - Current version of the canonical
league-data-schema(seetypesinterface).
Traits§
Functions§
- host_
fetch - Fetches the response body for an HTTP GET request to
url, via the host’sfetchcapability.