Skip to main content

Crate fulltime_plugin_api

Crate fulltime_plugin_api 

Source
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§

exports

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.
NetworkFailure
A plugin’s upstream HTTP call failed at the network layer.
ParseVersionError
Error returned when parsing a Version from a string fails.
RateLimited
A plugin’s upstream source responded with a rate-limit error.
SchemaMappingFailure
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.
StandingsGroup
One ranked table, optionally named (e.g. “Group A”) for group-based formats. A single-table league format has exactly one unnamed group.
StandingsRow
One row of a standings table.
Team
A team taking part in one or more competitions.
Version
A major.minor version identifier for either the canonical schema or the data-provider interface.

Enums§

FixtureStatus
Lifecycle state of a fixture.
ManifestError
Error returned when a manifest fails to parse.
ManifestField
A manifest field that failed presence or format validation.
ProviderError
The error a data-provider operation returns on failure.

Constants§

INTERFACE_VERSION
Current version of the data-provider WIT interface.
SCHEMA_VERSION
Current version of the canonical league-data-schema (see types interface).

Traits§

Guest

Functions§

host_fetch
Fetches the response body for an HTTP GET request to url, via the host’s fetch capability.