Skip to main content

Crate oxicode_api_stability

Crate oxicode_api_stability 

Source
Expand description

Stability tier attribute macros for the oxicode workspace.

Provides four attributes that render as colored badges in cargo doc:

  • #[stable(since = "0.63.0")] — green badge, semver-stable
  • #[unstable(feature = "browser")] — amber badge, may change
  • #[internal] — hides from docs (#[doc(hidden)])
  • #[deprecated(since = "0.64.0")] — red badge + native deprecation warning

Attribute Macros§

deprecated
Attribute that marks an item as deprecated with a doc badge. Emits the native #[deprecated(since=..., note=...)] so consumers don’t need a second attribute. The macro name shadows the built-in #[deprecated] only inside the same use-scope — emit it via the qualified path #[oxicode_api_stability::deprecated(...)] or by importing under a different name (use oxicode_api_stability::deprecated as oxicode_deprecated;) if you also need the built-in. Accepts: since = "0.XX.0" (required), note = "..." (optional).
internal
Attribute that hides an item from consumer-facing docs.
stable
Attribute that marks an item as semver-stable.
unstable
Attribute that marks an item as semver-unstable.