Struct ApiMap
pub struct ApiMap {
pub crates: BTreeMap<String, bool>,
pub rust: BTreeMap<String, String>,
pub python: BTreeMap<String, String>,
pub cli: BTreeMap<String, String>,
}Expand description
The map’s contents, before they are rendered.
Exists so that cargo dev check-api-links can verify the values against a
built rustdoc tree and a built site without parsing the YAML back — which
would add a parser, and worse, would let the checker and the generator drift
apart in their reading of the same file. generate-all --mode check already
guarantees the file on disk is what map produces, so checking map’s
output is checking the file.
Fields§
§crates: BTreeMap<String, bool>Every workspace crate, and whether it is published (§12’s two lists).
rust: BTreeMap<String, String>atune::Study → atune/struct.Study.html, a path in a rustdoc tree.
python: BTreeMap<String, String>atune.Study → api/python.md#atune.Study, a page in this site.
cli: BTreeMap<String, String>atune run → reference/cli.md#atune-run, a page in this site.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for ApiMap
impl RefUnwindSafe for ApiMap
impl Send for ApiMap
impl Sync for ApiMap
impl Unpin for ApiMap
impl UnsafeUnpin for ApiMap
impl UnwindSafe for ApiMap
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T, U> Imply<T> for U
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more