Ferritin — Rust documentation

Show documentation for a Rust item by path.

{
  "type": "object",
  "properties": {
    "path": {
      "description": "Item path, e.g. `serde::Deserialize` or `std::vec::Vec`. A crate segment\nmay carry an `@`-suffixed semver requirement (not an exact version):\n`tokio@1::runtime::Runtime` serves the newest 1.x, while `tokio@=1.40`\npins an exact release.",
      "type": "string"
    }
  },
  "required": [
    "path"
  ],
  "examples": [
    {
      "description": "Look up a trait",
      "path": "serde::Deserialize"
    }
  ]
}

Search for items within a crate's documentation, or — without a crate — discover which crate to use.

{
  "type": "object",
  "properties": {
    "crate": {
      "description": "Crate to search within, optionally with an `@`-suffixed semver\nrequirement (not an exact version): `serde`, `tokio@1` (newest 1.x), or\n`tokio@=1.40` to pin an exact release.\n\n**Omit only to discover which crate to use.** With `crate`, the search\nruns over that crate's full documentation — item names and prose.\nWithout it, it searches a different, much shallower dataset: crates.io\ncrate names, descriptions, and declared keywords. It returns crates,\nnot items, and cannot see any crate's actual documentation. If you\nalready know the crate name, always pass it.",
      "type": "string"
    },
    "query": {
      "description": "Search query — one or more complete words. With `crate`, matched\nagainst item names and documentation prose; without it, against crate\nnames, descriptions, and declared keywords.",
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "examples": [
    {
      "crate": "serde",
      "description": "Find deserialization items in serde",
      "query": "deserialize"
    },
    {
      "description": "Discover which crate to use for MQTT",
      "query": "mqtt client"
    }
  ]
}