Expand description
Generated AT Protocol Lexicon bindings.
This crate contains Rust bindings generated from Lexicon schemas. Most
application code uses these types through the jacquard::api re-export,
alongside jacquard::Client or one of the higher-level session helpers.
§Finding things
Lexicon NSIDs map to Rust modules by replacing dots with module separators
and using snake_case for Rust identifiers. For example,
app.bsky.feed.getTimeline is generated under
app_bsky::feed::get_timeline.
Top-level namespace modules are feature-gated. Enable the feature matching
the top-level namespace module, such as app_bsky or com_atproto, to use
those bindings.
§String backing
Many generated data types are generic over a string backing type,
usually written as S: BosStr = DefaultStr. The generic is part of the
public API: use the default owned backing when you do not need to choose,
or select another backing such as String, &str, or CowStr<'_> when
that is useful for your code.
Common examples omit the generic because the default is inferred in the usual request/response paths.
§XRPC endpoints
Endpoint modules contain request parameter/input structs, output structs,
error enums, and marker types implementing
jacquard_common::xrpc::{XrpcRequest, XrpcResp, XrpcEndpoint}. High-level
client code normally constructs the request struct or marker type and sends
it with jacquard::Client, then uses response helpers such as
into_output() for default-backed output.
Modules§
- app_
bsky - Generated bindings for the
app.bskyLexicon namespace/module. - blog_
pckt - Generated bindings for the
blog.pcktLexicon namespace/module. - builder_
types - chat_
bsky - Generated bindings for the
chat.bskyLexicon namespace/module. - com_
atproto - Generated bindings for the
com.atprotoLexicon namespace/module. - com_
bad_ example - Generated bindings for the
com.bad.exampleLexicon namespace/module. - com_
whtwnd - Generated bindings for the
com.whtwndLexicon namespace/module. - games_
gamesgamesgamesgames - Generated bindings for the
games.gamesgamesgamesgamesLexicon namespace/module. - net_
anisota - Generated bindings for the
net.anisotaLexicon namespace/module. - network_
slices - Generated bindings for the
network.slicesLexicon namespace/module. - place_
stream - Generated bindings for the
place.streamLexicon namespace/module. - pub_
leaflet - Generated bindings for the
pub.leafletLexicon namespace/module. - sh_
tangled - Generated bindings for the
sh.tangledLexicon namespace/module. - sh_
weaver - Generated bindings for the
sh.weaverLexicon namespace/module. - site_
standard - Generated bindings for the
site.standardLexicon namespace/module. - tools_
ozone - Generated bindings for the
tools.ozoneLexicon namespace/module.