Jacquard

https://docs.rs/jacquard/0.11.0
Admin
Jacquard is a suite of Rust crates designed to simplify AT Protocol development with zero-copy...
Tokens:1,578,885
Snippets:10,293
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Advance Method Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/fluent_uri/build/struct.Builder.html

Example demonstrating the use of the `advance` method to change the builder state.

```APIDOC
## Example: Advance Method

```rust
use fluent_uri::{component::Scheme, pct_enc::EStr, UriRef};

fn build(relative: bool) -> UriRef<String> {
    let b = UriRef::builder();
    let b = if relative {
        b.advance()
    } else {
        b.scheme(Scheme::new_or_panic("http"))
            .authority_with(|b| b.host(EStr::new_or_panic("example.com")))
    };
    b.path(EStr::new_or_panic("/foo")).build().unwrap()
}

assert_eq!(build(false).as_str(), "http://example.com/foo");
assert_eq!(build(true).as_str(), "/foo");
```
```

--------------------------------

### FileTokenStore Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/session/struct.FileTokenStore.html

Example usage of FileTokenStore with AtClient.

```APIDOC
```rust
use jacquard::client::{AtClient, FileTokenStore};
let base = jacquard_common::deps::fluent_uri::Uri::parse("https://bsky.social").unwrap().to_owned();
let store = FileTokenStore::new("/tmp/jacquard-session.json");
let client = AtClient::new(reqwest::Client::new(), base, store);
```
```

--------------------------------

### Builder Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/fluent_uri/build/struct.Builder.html

Example demonstrating the basic usage of the Uri::builder() to construct a URI.

```APIDOC
## Example: Basic Usage

```rust
use fluent_uri::{component::Scheme, pct_enc::EStr, Uri};

const SCHEME_FOO: &Scheme = Scheme::new_or_panic("foo");

let uri = Uri::builder()
    .scheme(SCHEME_FOO)
    .authority_with(|b| {
        b.userinfo(EStr::new_or_panic("user"))
            .host(EStr::new_or_panic("example.com"))
            .port(8042)
    })
    .path(EStr::new_or_panic("/over/there"))
    .query(EStr::new_or_panic("name=ferret"))
    .fragment(EStr::new_or_panic("nose"))
    .build()
    .unwrap();

assert_eq!(
    uri.as_str(),
    "foo://user@example.com:8042/over/there?name=ferret#nose"
);
```

Note that `EStr::new_or_panic` _panics_ on invalid input and should normally be used with constant strings. If you want to build a percent-encoded string from scratch, use `EString` instead.
```

--------------------------------

### Example usage of AgentSessionExt

Source: https://docs.rs/jacquard/0.11.0/src/jacquard/client.rs.html

This example demonstrates creating a post and then reading it back using the `AgentSessionExt` trait. It requires the `api` feature and `tokio` runtime.

```rust
# use jacquard::client::BasicClient;
# use jacquard_api::app_bsky::feed::post::Post;
# use jacquard_common::types::string::{AtUri, Datetime};
# use jacquard_common::CowStr;
use jacquard::client::AgentSessionExt;
# #[tokio::main]
# async fn main() -> Result<(), Box<dyn std::error::Error>> {
# let agent: BasicClient = todo!();
// Create a post
let post = Post {
    text: CowStr::from("Hello from Jacquard!"),
    created_at: Datetime::now(),
    # embed: None, entities: None, facets: None, labels: None,
    # langs: None, reply: None, tags: None, extra_data: Default::default(),
};
let output = agent.create_record(post, None).await?;

// Read it back
let response = agent.get_record::<Post>(&output.uri).await?;
let record = response.parse()?;
println!("Post: {}", record.value.text);
# Ok(())
# }

```

--------------------------------

### Example Record API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

API for managing example records.

```APIDOC
## POST /api/dev/baileytownsend/demo/example

### Description
Manages example records.

### Method
POST

### Endpoint
/api/dev/baileytownsend/demo/example

### Parameters
#### Request Body
- **data** (object) - Required - The data for the example record.

### Response
#### Success Response (200)
- **output** (ExampleGetRecordOutput) - The created or updated example record.

#### Response Example
```json
{
  "output": {}
}
```
```

--------------------------------

### Conquering Wolfhound Example API

Source: https://docs.rs/jacquard/0.11.0/jacquard/types/collection/trait.Collection.html

API for accessing conquering wolfhound example data.

```APIDOC
## Conquering Wolfhound Example API

### Description
Provides access to conquering wolfhound example data.

### Namespace
garden.lexicon.conquering-wolfhound.example

### Record Type
ExampleRecord
```

--------------------------------

### Optional Component Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/fluent_uri/build/struct.Builder.html

Example showing how to use the `optional` method to conditionally add components.

```APIDOC
## Example: Optional Components

```rust
use fluent_uri::{build::Builder, pct_enc::EStr, UriRef};

let uri_ref = UriRef::builder()
    .path(EStr::new_or_panic("foo"))
    .optional(Builder::query, Some(EStr::new_or_panic("bar")))
    .optional(Builder::fragment, None)
    .build()
    .unwrap();

assert_eq!(uri_ref.as_str(), "foo?bar");
```
```

--------------------------------

### Get Post Thread API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Endpoint to get a thread of posts starting from a specific post.

```APIDOC
## GET /xrpc/app.bsky.feed.getPostThread

### Description
Retrieves a thread of posts, starting from a given post.

### Method
GET

### Endpoint
/xrpc/app.bsky.feed.getPostThread

### Request Body
- **GetPostThread** (object) - Required - The request body for getting a post thread.

### Response
#### Success Response (200)
- **GetPostThreadResponse** (object) - The response object for a successful retrieval of a post thread.
```

--------------------------------

### Get Onboarding Suggested Starter Packs

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves suggested starter packs for new users during onboarding.

```APIDOC
## GET /xrpc/app.bsky.unspecced.getOnboardingSuggestedStarterPacks

### Description
Retrieves a list of suggested starter packs (e.g., curated feeds, user lists) to help new users get started on the platform.

### Method
GET

### Endpoint
/xrpc/app.bsky.unspecced.getOnboardingSuggestedStarterPacks

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of starter packs to return.

### Response
#### Success Response (200)
- **starterPacks** (array) - A list of suggested starter pack objects.

#### Response Example
```json
{
  "starterPacks": [
    {
      "id": "starter_pack_1",
      "name": "Getting Started",
      "description": "Essential feeds and users for new members."
    }
  ]
}
```
```

--------------------------------

### Example of Moderation Function Usage

Source: https://docs.rs/jacquard/0.11.0/src/jacquard/moderation/decision.rs.html

Illustrates how to use the `moderate` function with a `PostView`, user preferences, and labeler definitions. This example is marked as `ignore` and is for documentation purposes.

```rust
# use jacquard::moderation::*;
# use jacquard_api::app_bsky::feed::PostView;
# fn example(post: &PostView<'_>, prefs: &ModerationPrefs<'_>, defs: &LabelerDefs<'_>) {
let decision = moderate(post, prefs, defs, &[]);
if decision.filter {
    println!("This post should be hidden");
}
# }

```

--------------------------------

### GET /xrpc/app.bsky.unspecced.getSuggestedStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves a list of suggested starter packs.

```APIDOC
## GET /xrpc/app.bsky.unspecced.getSuggestedStarterPacks

### Method
GET

### Endpoint
/xrpc/app.bsky.unspecced.getSuggestedStarterPacks
```

--------------------------------

### NaiveDate Iterators

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/naive/struct.NaiveDate.html

Example of iterating over weeks starting from a specific date.

```APIDOC
## NaiveDate Iterators

### Description
Example of iterating over weeks starting from a specific date.

### Code Example
```rust
let expected = [
    NaiveDate::from_ymd_opt(2016, 2, 27).unwrap(),
    NaiveDate::from_ymd_opt(2016, 3, 5).unwrap(),
    NaiveDate::from_ymd_opt(2016, 3, 12).unwrap(),
    NaiveDate::from_ymd_opt(2016, 3, 19).unwrap(),
];

let mut count = 0;
for (idx, d) in NaiveDate::from_ymd_opt(2016, 2, 27).unwrap().iter_weeks().take(4).enumerate() {
    assert_eq!(d, expected[idx]);
    count += 1;
}
assert_eq!(count, 4);

for d in NaiveDate::from_ymd_opt(2016, 3, 19).unwrap().iter_weeks().rev().take(4) {
    count -= 1;
    assert_eq!(d, expected[count]);
}
```
```

--------------------------------

### GET com.atproto.sync.listRepos

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcRequest.html

Lists all repositories.

```APIDOC
## GET com.atproto.sync.listRepos

### Description
Lists all repositories.

### Method
GET

### Endpoint
com.atproto.sync.listRepos

### Response
- **Response** (ListReposResponse) - The response object containing the list of repositories.
```

--------------------------------

### GET app.bsky.unspecced.getSuggestedStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcRequest.html

Retrieves suggested starter packs.

```APIDOC
## GET app.bsky.unspecced.getSuggestedStarterPacks

### Method
GET

### Endpoint
app.bsky.unspecced.getSuggestedStarterPacks

### Response
- **Response** (GetSuggestedStarterPacksResponse)
```

--------------------------------

### GET /chunk

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/bytes/buf/trait.Buf.html

Returns a slice starting at the current position of the buffer.

```APIDOC
## GET /chunk

### Description
Returns a slice starting at the current position and of length between 0 and Buf::remaining().

### Method
GET

### Endpoint
/chunk

### Response
#### Success Response (200)
- **chunk** (slice) - A slice of bytes starting at the current cursor position.
```

--------------------------------

### GET /xrpc/app.bsky.unspecced.getSuggestedStarterPacksSkeleton

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves a skeleton list of suggested starter packs.

```APIDOC
## GET /xrpc/app.bsky.unspecced.getSuggestedStarterPacksSkeleton

### Method
GET

### Endpoint
/xrpc/app.bsky.unspecced.getSuggestedStarterPacksSkeleton
```

--------------------------------

### Get Day of Year (0-based)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/naive/struct.NaiveDateTime.html

Returns the day of the year starting from 0. The return value ranges from 0 to 365.

```rust
use chrono::{Datelike, NaiveDate, NaiveDateTime};

let dt: NaiveDateTime =
    NaiveDate::from_ymd_opt(2015, 9, 25).unwrap().and_hms_opt(12, 34, 56).unwrap();
assert_eq!(dt.ordinal0(), 267);
```

--------------------------------

### Get Day of Year (1-based)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/naive/struct.NaiveDateTime.html

Returns the day of the year starting from 1. The return value ranges from 1 to 366.

```rust
use chrono::{Datelike, NaiveDate, NaiveDateTime};

let dt: NaiveDateTime =
    NaiveDate::from_ymd_opt(2015, 9, 25).unwrap().and_hms_opt(12, 34, 56).unwrap();
assert_eq!(dt.ordinal(), 268);
```

--------------------------------

### app.bsky.graph.getStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

Retrieves a list of starter packs.

```APIDOC
## GET app.bsky.graph.getStarterPacks

### Description
Retrieves a list of starter packs.

### Method
GET

### Endpoint
/app.bsky.graph.getStarterPacks

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of starter packs to return.
- **cursor** (string) - Optional - The cursor for pagination.

### Response
#### Success Response (200)
- **starterPacks** (array) - A list of starter packs.
- **cursor** (string) - Optional - A cursor for pagination.
```

--------------------------------

### GET /xrpc/tools.ozone.verification.listVerifications

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Lists verifications.

```APIDOC
## GET /xrpc/tools.ozone.verification.listVerifications

### Description
Retrieves a list of verifications.

### Method
GET

### Endpoint
/xrpc/tools.ozone.verification.listVerifications
```

--------------------------------

### Get Day of Month (0-based)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/naive/struct.NaiveDateTime.html

Returns the day of the month starting from 0. The return value ranges from 0 to 30.

```rust
use chrono::{Datelike, NaiveDate, NaiveDateTime};

let dt: NaiveDateTime =
    NaiveDate::from_ymd_opt(2015, 9, 25).unwrap().and_hms_opt(12, 34, 56).unwrap();
assert_eq!(dt.day0(), 24);
```

--------------------------------

### GET /xrpc/app.bsky.graph.getStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves a list of available starter packs.

```APIDOC
## GET /xrpc/app.bsky.graph.getStarterPacks

### Description
Retrieves a list of available starter packs.

### Method
GET

### Endpoint
/xrpc/app.bsky.graph.getStarterPacks

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - The cursor for the next page of results.
- **limit** (integer) - Optional - The number of results to return per page. Defaults to 20.

### Response
#### Success Response (200)
- **starterPacks** (array) - A list of starter packs.
  - **id** (string) - The ID of the starter pack.
  - **name** (string) - The name of the starter pack.
  - **description** (string) - The description of the starter pack.
  - **creator** (object) - Information about the creator of the starter pack.
    - **did** (string) - The DID of the creator.
    - **handle** (string) - The handle of the creator.
- **cursor** (string) - The cursor for the next page of results.
```

--------------------------------

### Simple API Client Example

Source: https://docs.rs/jacquard/0.11.0/src/jacquard/lib.rs.html

Demonstrates how to build a basic API client using Jacquard. It shows OAuth login with a loopback server for authentication and fetching the latest posts from a user's timeline. Requires the 'loopback' feature to be enabled.

```rust
# use clap::Parser;
# use jacquard::CowStr;
use jacquard::api::app_bsky::feed::get_timeline::GetTimeline;
use jacquard::client::{Agent, FileAuthStore};
use jacquard::oauth::client::OAuthClient;
use jacquard::xrpc::XrpcClient;
use jacquard::oauth::types::AuthorizeOptions;
# #[cfg(feature = "loopback")]
use jacquard::oauth::loopback::LoopbackConfig;
# use miette::IntoDiagnostic;

# #[derive(Parser, Debug)]
# #[command(author, version, about = "Jacquard - OAuth (DPoP) loopback demo")]
# struct Args {
#     /// Handle (e.g., alice.bsky.social), DID, or PDS URL
#     input: CowStr<'static>,
#
#     /// Path to auth store file (will be created if missing)
#     #[arg(long, default_value = "/tmp/jacquard-oauth-session.json")]
#     store: String,
# }
# 
#[tokio::main]
async fn main() -> miette::Result<()> {
    let args = Args::parse();

    // Build an OAuth client with file-backed auth store and default localhost config
    let oauth = OAuthClient::with_default_config(FileAuthStore::new(&args.store));
    // Authenticate with a PDS, using a loopback server to handle the callback flow
    #[cfg(feature = "loopback")]
    let session = oauth
       .login_with_local_server(
           args.input.clone(),
           AuthorizeOptions::default(),
           LoopbackConfig::default(),
       )
       .await?;
    #[cfg(not(feature = "loopback"))]
    compile_error!("loopback feature must be enabled to run this example");
    // Wrap in Agent and fetch the timeline
    let agent: Agent<_> = Agent::from(session);
    let timeline = agent
        .send(GetTimeline::new().limit(5).build())
        .await?;
        .into_output()?;
    for (i, post) in timeline.feed.iter().enumerate() {
        println!("\n{}. by {}", i + 1, post.post.author.handle);
        println!(
            "   {}",
            serde_json::to_string_pretty(&post.post.record).into_diagnostic()?
        );
    }
    Ok(())
}

```

--------------------------------

### Get Month Component (0-11)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/trait.Datelike.html

Retrieves the month component of a date, starting from 0. The return value ranges from 0 to 11.

```rust
fn month0(&self) -> u32;
```

--------------------------------

### Initialize FileTokenStore

Source: https://docs.rs/jacquard/0.11.0/jacquard/session/struct.FileTokenStore.html

Demonstrates how to instantiate a FileTokenStore and use it to initialize an AtClient. This implementation is not secure and should only be used for development purposes.

```rust
use jacquard::client::{AtClient, FileTokenStore};
let base = jacquard_common::deps::fluent_uri::Uri::parse("https://bsky.social").unwrap().to_owned();
let store = FileTokenStore::new("/tmp/jacquard-session.json");
let client = AtClient::new(reqwest::Client::new(), base, store);
```

--------------------------------

### Get Month Component (1-12)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/trait.Datelike.html

Retrieves the month component of a date, starting from 1. The return value ranges from 1 to 12.

```rust
fn month(&self) -> u32;
```

--------------------------------

### Get Ordinal Day (0-365)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/trait.Datelike.html

Retrieves the day of the year, starting from 0. The return value ranges from 0 to 365, varying by year.

```rust
fn ordinal0(&self) -> u32;
```

--------------------------------

### Get Onboarding Suggested Starter Packs Skeleton

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves a skeleton structure for onboarding suggested starter packs.

```APIDOC
## GET /xrpc/app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton

### Description
Retrieves a skeleton structure for onboarding suggested starter packs. This is useful for pre-loading UI elements before the actual data is fetched.

### Method
GET

### Endpoint
/xrpc/app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton

### Response
#### Success Response (200)
- **skeleton** (object) - The skeleton structure for starter packs.

#### Response Example
```json
{
  "skeleton": {
    "pending": [
      "starter_pack_1",
      "starter_pack_2"
    ]
  }
}
```
```

--------------------------------

### Get Ordinal Day (1-366)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/trait.Datelike.html

Retrieves the day of the year, starting from 1. The return value ranges from 1 to 366, varying by year.

```rust
fn ordinal(&self) -> u32;
```

--------------------------------

### app.bsky.graph.getStarterPack

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

Retrieves a specific starter pack.

```APIDOC
## GET app.bsky.graph.getStarterPack

### Description
Retrieves a specific starter pack.

### Method
GET

### Endpoint
/app.bsky.graph.getStarterPack

### Parameters
#### Query Parameters
- **starterPack** (string) - Required - The AT-URI of the starter pack to retrieve.

### Response
#### Success Response (200)
- **starterPack** (object) - The starter pack object.
```

--------------------------------

### Get Day Component (0-30)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/trait.Datelike.html

Retrieves the day of the month, starting from 0. The return value ranges from 0 to 30, varying by month.

```rust
fn day0(&self) -> u32;
```

--------------------------------

### Get Suggested Starter Packs

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

Retrieves suggested starter packs.

```APIDOC
## GET /app.bsky.unspecced.getSuggestedStarterPacks

### Description
Retrieves suggested starter packs.

### Method
GET

### Endpoint
/app.bsky.unspecced.getSuggestedStarterPacks

### Parameters

### Request Body

### Request Example

### Response
#### Success Response (200)
- **Output** (object) - The output of the GetSuggestedStarterPacks operation.

#### Response Example
```json
{
  "Output": {}
}
```
```

--------------------------------

### Example Usage: Creating a Post

Source: https://docs.rs/jacquard/0.11.0/jacquard/client/credential_session/struct.CredentialSession.html

Demonstrates how to create and send a post using the Jacquard client library.

```APIDOC
## Example Usage: Creating a Post

### Description

This example shows the basic steps to authenticate, create a post object, and send it using the `Agent`.

### Method

N/A (Illustrative example)

### Endpoint

N/A (Illustrative example)

### Request Example

```rust
use jacquard::client::MemoryCredentialSession;
use jacquard::client::{Agent, AgentSessionExt};
use jacquard::types::post::Post;
use bluesky_crypto::did::Did;
use chrono::Utc;

// Assuming 'identifier' and 'password' are defined elsewhere
// let identifier: Did<'static> = ...;
// let password = "...";
// let post_text = "This is my first post!";

async fn create_example_post(identifier: Did<'static>, password: &str, post_text: &str) -> Result<(), Box<dyn std::error::Error>> {
    let (session, _) = MemoryCredentialSession::authenticated(identifier, password, None, None).await?;
    let agent = Agent::from(session);
    let post = Post::new()
        .text(post_text)
        .created_at(Utc::now())
        .build();
    let output = agent.create_record(post, None).await?;
    println!("Post created successfully: {:?}", output);
    Ok(())
}
```

### Response Example

*   **Success Response**: The `output` variable will contain the result of the `create_record` operation, typically a success indicator or details about the created record.
*   **Error Response**: The function will return an error if authentication fails, the post cannot be created, or any network issues occur.
```

--------------------------------

### Get Day Component (1-31)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/trait.Datelike.html

Retrieves the day of the month, starting from 1. The return value ranges from 1 to 31, varying by month.

```rust
fn day(&self) -> u32;
```

--------------------------------

### String Length Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/types/blob/struct.MimeType.html

Demonstrates how to get the length of a string in bytes. Note that this might not correspond to the number of characters, especially with multi-byte UTF-8 characters.

```rust
let len = "foo".len();
assert_eq!(3, len);

assert_eq!("ƒoo".len(), 4); // fancy f!
assert_eq!("ƒoo".chars().count(), 3);

```

--------------------------------

### Create Basic Subscription Client with Options

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/subscription/type.TungsteniteSubscriptionClient.html

Allows creating a basic subscription client with default subscription options.

```rust
pub fn with_options( self, opts: SubscriptionOptions<'_>, ) -> BasicSubscriptionClient<W>
```

--------------------------------

### Get ISO Week Number (0-52)

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/naive/struct.IsoWeek.html

Returns the ISO week number, starting from 0. The range is 0 to 52, and the last week of the year can vary.

```rust
use chrono::{Datelike, NaiveDate, Weekday};

let d = NaiveDate::from_isoywd_opt(2015, 15, Weekday::Mon).unwrap();
assert_eq!(d.iso_week().week0(), 14);
```

--------------------------------

### GET /xrpc/app.bsky.graph.getStarterPack

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves details for a specific starter pack.

```APIDOC
## GET /xrpc/app.bsky.graph.getStarterPack

### Description
Retrieves details for a specific starter pack.

### Method
GET

### Endpoint
/xrpc/app.bsky.graph.getStarterPack

### Parameters
#### Query Parameters
- **packId** (string) - Required - The ID of the starter pack to retrieve.

### Response
#### Success Response (200)
- **starterPack** (object) - Information about the starter pack.
  - **id** (string) - The ID of the starter pack.
  - **name** (string) - The name of the starter pack.
  - **description** (string) - The description of the starter pack.
  - **creator** (object) - Information about the creator of the starter pack.
    - **did** (string) - The DID of the creator.
    - **handle** (string) - The handle of the creator.
  - **items** (array) - A list of items in the starter pack.
    - **type** (string) - The type of item (e.g., 'profile', 'list').
    - **id** (string) - The ID of the item.
```

--------------------------------

### GET /xrpc/app.bsky.graph.searchStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Searches for starter packs based on a query.

```APIDOC
## GET /xrpc/app.bsky.graph.searchStarterPacks

### Description
Searches for starter packs based on a query.

### Method
GET

### Endpoint
/xrpc/app.bsky.graph.searchStarterPacks

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query.
- **cursor** (string) - Optional - The cursor for the next page of results.
- **limit** (integer) - Optional - The number of results to return per page. Defaults to 20.

### Response
#### Success Response (200)
- **starterPacks** (array) - A list of starter packs matching the query.
  - **id** (string) - The ID of the starter pack.
  - **name** (string) - The name of the starter pack.
  - **description** (string) - The description of the starter pack.
  - **creator** (object) - Information about the creator of the starter pack.
    - **did** (string) - The DID of the creator.
    - **handle** (string) - The handle of the creator.
- **cursor** (string) - The cursor for the next page of results.
```

--------------------------------

### Collect match indices with repeated patterns

Source: https://docs.rs/jacquard/0.11.0/jacquard/enum.CowStr.html

This example demonstrates collecting match indices for a pattern that appears multiple times, showing the starting index for each non-overlapping match.

```rust
let v: Vec<_> = "1abcabc2".match_indices("abc").collect();
assert_eq!(v, [(1, "abc"), (4, "abc")]);
```

--------------------------------

### GET /xrpc/tools.ozone.setting.listOptions

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Lists options for ozone settings.

```APIDOC
## GET /xrpc/tools.ozone.setting.listOptions

### Description
Retrieves a list of available options.

### Method
GET

### Endpoint
/xrpc/tools.ozone.setting.listOptions
```

--------------------------------

### Collect match indices of a string pattern

Source: https://docs.rs/jacquard/0.11.0/jacquard/enum.CowStr.html

Use `match_indices` to get the starting index and the matched substring for each occurrence of a pattern. This method returns matches from the beginning of the string.

```rust
let v: Vec<_> = "abcXXXabcYYYabc".match_indices("abc").collect();
assert_eq!(v, [(0, "abc"), (6, "abc"), (12, "abc")]);
```

--------------------------------

### Trim leading whitespace considering text directionality

Source: https://docs.rs/jacquard/0.11.0/jacquard/enum.CowStr.html

This example shows `trim_start` behavior with different text directions, ensuring it correctly identifies the start of the content regardless of language.

```rust
let s = "  English  ";
assert!(Some('E') == s.trim_start().chars().next());

let s = "  עברית  ";
assert!(Some('ע') == s.trim_start().chars().next());
```

--------------------------------

### app.bsky.graph.searchStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

Searches for starter packs.

```APIDOC
## GET /app.bsky.graph.searchStarterPacks

### Description
Searches for starter packs based on provided criteria.

### Method
GET

### Endpoint
/app.bsky.graph.searchStarterPacks

### Parameters
#### Query Parameters
- **query** (string) - Optional - The search query string.
- **limit** (integer) - Optional - The maximum number of results to return.
- **cursor** (string) - Optional - A cursor for pagination.

### Response
#### Success Response (200)
- **starterPacks** (array) - An array of starter pack objects.
- **cursor** (string) - A cursor for the next page of results.

#### Response Example
```json
{
  "starterPacks": [
    {
      "name": "Example Starter Pack",
      "description": "A collection of useful items."
    }
  ],
  "cursor": "next_cursor_string"
}
```
```

--------------------------------

### Weekday Parsing and Day Number Examples

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/enum.Weekday.html

Demonstrates parsing a string into a Weekday, converting an integer to a Weekday, and using methods to get day numbers relative to Monday and Sunday.

```rust
use chrono::Weekday;

let monday = "Monday".parse::<Weekday>().unwrap();
assert_eq!(monday, Weekday::Mon);

let sunday = Weekday::try_from(6).unwrap();
assert_eq!(sunday, Weekday::Sun);

assert_eq!(sunday.num_days_from_monday(), 6); // starts counting with Monday = 0
assert_eq!(sunday.number_from_monday(), 7); // starts counting with Monday = 1
assert_eq!(sunday.num_days_from_sunday(), 0); // starts counting with Sunday = 0
assert_eq!(sunday.number_from_sunday(), 1); // starts counting with Sunday = 1

assert_eq!(sunday.succ(), monday);
assert_eq!(sunday.pred(), Weekday::Sat);
```

--------------------------------

### Example Usage of TungsteniteSubscriptionClient

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/subscription/type.TungsteniteSubscriptionClient.html

Demonstrates how to create a TungsteniteSubscriptionClient instance from a base URI. The subscription call is commented out but shows the intended usage.

```rust
let base = Uri::parse("wss://bsky.network")?.to_owned();
let client = TungsteniteSubscriptionClient::from_base_uri(base);
// let conn = client.subscribe(&params).await?;
```

--------------------------------

### Accessing Metadata with `and_then`

Source: https://docs.rs/jacquard/0.11.0/jacquard/client/error/type.Result.html

This example shows how `and_then` can be used to chain operations that might fail, such as getting file metadata. It demonstrates successful retrieval and handling of a 'not found' error.

```rust
use std::{io::ErrorKind, path::Path};

// Note: on Windows "/" maps to "C:\\"
let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified());
assert!(root_modified_time.is_ok());

let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified());
assert!(should_fail.is_err());
assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound);
```

--------------------------------

### Get Element Offset in Slice

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/bytes/struct.Bytes.html

Returns the index of an element reference within a slice. Returns `None` if the element does not point to the start of an element. Useful for extending slice iterators. Panics if `T` is zero-sized.

```rust
let nums: &[u32] = &[1, 7, 1, 1];
let num = &nums[2];

assert_eq!(num, &1);
assert_eq!(nums.element_offset(num), Some(2));
```

```rust
let arr: &[[u32; 2]] = &[[0, 1], [2, 3]];
let flat_arr: &[u32] = arr.as_flattened();

let ok_elm: &[u32; 2] = flat_arr[0..2].try_into().unwrap();
let weird_elm: &[u32; 2] = flat_arr[1..3].try_into().unwrap();

assert_eq!(ok_elm, &[0, 1]);
assert_eq!(weird_elm, &[1, 2]);

assert_eq!(arr.element_offset(ok_elm), Some(0)); // Points to element 0
assert_eq!(arr.element_offset(weird_elm), None); // Points between element 0 and 1
```

--------------------------------

### Get Suggested Starter Packs Skeleton

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

Retrieves a skeleton of suggested starter packs.

```APIDOC
## GET /app.bsky.unspecced.getSuggestedStarterPacksSkeleton

### Description
Retrieves a skeleton of suggested starter packs.

### Method
GET

### Endpoint
/app.bsky.unspecced.getSuggestedStarterPacksSkeleton

### Parameters

### Request Body

### Request Example

### Response
#### Success Response (200)
- **Output** (object) - The output of the GetSuggestedStarterPacksSkeleton operation.

#### Response Example
```json
{
  "Output": {}
}
```
```

--------------------------------

### Collect reverse match indices with repeated patterns

Source: https://docs.rs/jacquard/0.11.0/jacquard/enum.CowStr.html

This example demonstrates collecting match indices for a pattern that appears multiple times, showing the starting index for each non-overlapping match, processed from the end of the string.

```rust
let v: Vec<_> = "1abcabc2".rmatch_indices("abc").collect();
assert_eq!(v, [(4, "abc"), (1, "abc")]);
```

--------------------------------

### Authenticate with MemoryCredentialSession

Source: https://docs.rs/jacquard/0.11.0/jacquard/client/type.MemoryCredentialSession.html

Example demonstrating how to authenticate a session and create an agent to perform actions.

```rust
use jacquard::client::MemoryCredentialSession;
use jacquard::client::{Agent, AgentSessionExt};
let (session, _) = MemoryCredentialSession::authenticated(identifier, password, None, None).await?;
let agent = Agent::from(session);
let post = Post::new().text(post_text).created_at(Datetime::now()).build();
let output = agent.create_record(post, None).await?;
```

--------------------------------

### Streaming Download Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/stream/index.html

Demonstrates how to stream a download using HttpClientExt and futures_lite::StreamExt. Process chunks without loading the entire file into memory.

```rust
use jacquard_common::http_client::{HttpClient, HttpClientExt};
use futures_lite::StreamExt;

let client = reqwest::Client::new();
let request = http::Request::builder()
    .uri("https://example.com/large-file")
    .body(vec![])
    .unwrap();

let response = client.send_http_streaming(request).await?;
let (_parts, body) = response.into_parts();
let mut stream = Box::pin(body.into_inner());

// Use futures_lite::StreamExt for iteration
while let Some(chunk) = stream.as_mut().try_next().await? {
    // Process chunk without loading entire file into memory
}
```

--------------------------------

### Collect reverse match indices of a string pattern

Source: https://docs.rs/jacquard/0.11.0/jacquard/enum.CowStr.html

Use `rmatch_indices` to get the starting index and the matched substring for each occurrence of a pattern, yielded in reverse order. For overlapping matches, only the last match is returned.

```rust
let v: Vec<_> = "abcXXXabcYYYabc".rmatch_indices("abc").collect();
assert_eq!(v, [(12, "abc"), (6, "abc"), (0, "abc")]);
```

--------------------------------

### Get current UTC time and date

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/offset/struct.Utc.html

Obtain the current date and time in UTC using `Utc::now()`. You can then extract the naive date using `.date_naive()`. This example also demonstrates converting to a specific timezone using `with_timezone`.

```rust
// Current time in UTC
let now_utc = Utc::now();

// Current date in UTC
let today_utc = now_utc.date_naive();

// Current time in some timezone (let's use +05:00)
let offset = FixedOffset::east_opt(5 * 60 * 60).unwrap();
let now_with_offset = Utc::now().with_timezone(&offset);
```

--------------------------------

### Dead Simple API Client Example

Source: https://docs.rs/jacquard/0.11.0/index.html

Demonstrates logging in with OAuth and fetching the latest 5 posts from the timeline using the Jacquard Agent. Requires `tokio` for async operations and `miette` for error handling. The `FileAuthStore` and `LoopbackConfig` are used for OAuth authentication.

```rust
use jacquard::api::app_bsky::feed::get_timeline::GetTimeline;
use jacquard::client::{Agent, FileAuthStore};
use jacquard::oauth::client::OAuthClient;
use jacquard::xrpc::XrpcClient;
use jacquard::oauth::types::AuthorizeOptions;
use jacquard::oauth::loopback::LoopbackConfig;

#[tokio::main]
async fn main() -> miette::Result<()> {
    let args = Args::parse();

    // Build an OAuth client with file-backed auth store and default localhost config
    let oauth = OAuthClient::with_default_config(FileAuthStore::new(&args.store));
    // Authenticate with a PDS, using a loopback server to handle the callback flow
    let session = oauth
       .login_with_local_server(
           args.input.clone(),
           AuthorizeOptions::default(),
           LoopbackConfig::default(),
       )
       .await?;
    // Wrap in Agent and fetch the timeline
    let agent: Agent<_> = Agent::from(session);
    let timeline = agent
        .send(GetTimeline::new().limit(5).build())
        .await?;
    let timeline = timeline.into_output()?;
    for (i, post) in timeline.feed.iter().enumerate() {
        println!("\n{}. by {}", i + 1, post.post.author.handle);
        println!(
            "   {}",
            serde_json::to_string_pretty(&post.post.record).into_diagnostic()? 
        );
    }
    Ok(())
}
```

--------------------------------

### Box::new Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/error/type.BoxError.html

Demonstrates creating a boxed value and comparing it with a value created using Box::from.

```rust
let x = 5;
let boxed = Box::new(5);

assert_eq!(Box::from(x), boxed);
```

--------------------------------

### Start Livestream

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcRequest.html

Starts a livestream.

```APIDOC
## POST /place/stream/live/startLivestream

### Description
Starts a livestream.

### Method
POST

### Endpoint
/place/stream/live/startLivestream

### Response
#### Success Response (200)
- **response** (StartLivestreamResponse) - The response from the start operation.
```

--------------------------------

### BskyAppProgressGuide Static Conversion

Source: https://docs.rs/jacquard/0.11.0/jacquard/into_static/trait.IntoStatic.html

Demonstrates the conversion of BskyAppProgressGuide to its static output type.

```APIDOC
## BskyAppProgressGuide Static Conversion

### Description
Converts a `BskyAppProgressGuide` instance to its static output type.

### Method
`into_static`

### Endpoint
N/A (This is a Rust method, not an API endpoint)

### Parameters
None

### Request Body
None

### Response
#### Success Response
- **Output** (BskyAppProgressGuide<'static>) - The static version of the BskyAppProgressGuide.

### Request Example
```rust
let app_progress = BskyAppProgressGuide::new(); // Assuming a constructor
let static_app_progress = app_progress.into_static();
```

### Response Example
```rust
// The type of static_app_progress will be BskyAppProgressGuide<'static>
```
```

--------------------------------

### Get Quotes API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Endpoint to get quotes of a post.

```APIDOC
## GET /xrpc/app.bsky.feed.getQuotes

### Description
Retrieves posts that quote a specific post.

### Method
GET

### Endpoint
/xrpc/app.bsky.feed.getQuotes

### Request Body
- **GetQuotes** (object) - Required - The request body for getting quotes.

### Response
#### Success Response (200)
- **GetQuotesResponse** (object) - The response object for a successful retrieval of quotes.
```

--------------------------------

### Create a Post Record

Source: https://docs.rs/jacquard/0.11.0/jacquard/client/trait.AgentSessionExt.html

Example of creating a new post record with various optional fields. Ensure `AgentSessionExt` is in scope.

```rust
use jacquard::client::AgentSessionExt;
let post = Post {
    text: CowStr::from("Hello world!"),
    created_at: Datetime::now(),
    embed: None,
    entities: None,
    facets: None,
    labels: None,
    langs: None,
    reply: None,
    tags: None,
    extra_data: Default::default(),
};
let output = agent.create_record(post, None).await?;
println!("Created record: {}", output.uri);
```

--------------------------------

### Hello API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

A simple 'hello world' endpoint.

```APIDOC
## GET /xrpc/garden.lexicon.ngerakines.helloworld.Hello

### Description
Provides a basic 'hello world' response.

### Method
GET

### Endpoint
/xrpc/garden.lexicon.ngerakines.helloworld.Hello

### Response
#### Success Response (200)
- **HelloResponse** (object) - The response containing a greeting message.
```

--------------------------------

### Get Posts API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Endpoint to get multiple posts.

```APIDOC
## GET /xrpc/app.bsky.feed.getPosts

### Description
Retrieves multiple posts based on specified criteria.

### Method
GET

### Endpoint
/xrpc/app.bsky.feed.getPosts

### Request Body
- **GetPosts** (object) - Required - The request body for getting posts.

### Response
#### Success Response (200)
- **GetPostsResponse** (object) - The response object for a successful retrieval of posts.
```

--------------------------------

### Get Likes API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Endpoint to get likes for a post.

```APIDOC
## GET /xrpc/app.bsky.feed.getLikes

### Description
Retrieves the likes for a specific post.

### Method
GET

### Endpoint
/xrpc/app.bsky.feed.getLikes

### Request Body
- **GetLikes** (object) - Required - The request body for getting likes.

### Response
#### Success Response (200)
- **GetLikesResponse** (object) - The response object for a successful retrieval of likes.
```

--------------------------------

### app.bsky.graph.starterpack

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcResp.html

Retrieves a specific starter pack record.

```APIDOC
## GET /app.bsky.graph.starterpack

### Description
Retrieves a specific starter pack record by its identifier.

### Method
GET

### Endpoint
/app.bsky.graph.starterpack

### Parameters
#### Query Parameters
- **uri** (string) - Required - The URI of the starter pack record.

### Response
#### Success Response (200)
- **value** (object) - The starter pack record.

#### Response Example
```json
{
  "value": {
    "$type": "app.bsky.graph.starterpack",
    "name": "Example Starter Pack",
    "description": "A collection of useful items.",
    "items": [
      "uri1",
      "uri2"
    ],
    "createdAt": "2023-10-27T10:10:00Z"
  }
}
```
```

--------------------------------

### Get Feed API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Endpoint to get a specific feed.

```APIDOC
## GET /xrpc/app.bsky.feed.getFeed

### Description
Retrieves a specific feed.

### Method
GET

### Endpoint
/xrpc/app.bsky.feed.getFeed

### Request Body
- **GetFeed** (object) - Required - The request body for getting a feed.

### Response
#### Success Response (200)
- **GetFeedResponse** (object) - The response object for a successful retrieval of a feed.
```

--------------------------------

### GET /xrpc/app.bsky.unspecced.getSuggestedOnboardingUsers

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves a list of suggested users for onboarding.

```APIDOC
## GET /xrpc/app.bsky.unspecced.getSuggestedOnboardingUsers

### Method
GET

### Endpoint
/xrpc/app.bsky.unspecced.getSuggestedOnboardingUsers
```

--------------------------------

### Get Feed Skeleton API

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Endpoint to get a skeleton of a feed.

```APIDOC
## GET /xrpc/app.bsky.feed.getFeedSkeleton

### Description
Retrieves a skeleton of a feed, useful for pagination.

### Method
GET

### Endpoint
/xrpc/app.bsky.feed.getFeedSkeleton

### Request Body
- **GetFeedSkeleton** (object) - Required - The request body for getting a feed skeleton.

### Response
#### Success Response (200)
- **GetFeedSkeletonResponse** (object) - The response object for a successful retrieval of a feed skeleton.
```

--------------------------------

### Get Length of WeekdaySet

Source: https://docs.rs/jacquard/0.11.0/jacquard/deps/chrono/struct.WeekdaySet.html

Demonstrates getting the number of days in a WeekdaySet.

```rust
use chrono::Weekday::*;
assert_eq!(WeekdaySet::single(Mon).len(), 1);
assert_eq!(WeekdaySet::from_array([Mon, Wed, Fri]).len(), 3);
assert_eq!(WeekdaySet::ALL.len(), 7);
```

--------------------------------

### GET /xrpc/app.bsky.graph.getActorStarterPacks

Source: https://docs.rs/jacquard/0.11.0/jacquard/xrpc/trait.XrpcEndpoint.html

Retrieves starter packs for a given actor.

```APIDOC
## GET /xrpc/app.bsky.graph.getActorStarterPacks

### Description
Retrieves starter packs for a given actor.

### Method
GET

### Endpoint
/xrpc/app.bsky.graph.getActorStarterPacks

### Parameters
#### Query Parameters
- **actor** (string) - Required - The DID of the actor.

### Response
#### Success Response (200)
- **items** (array) - A list of starter pack objects.

#### Response Example
{
  "items": [
    {
      "name": "Starter Pack 1",
      "description": "A collection of useful accounts."
    }
  ]
}
```

--------------------------------

### Streaming Download Example

Source: https://docs.rs/jacquard/0.11.0/jacquard/stream/index.html

Demonstrates how to perform a streaming HTTP download using the ByteStream abstraction to process data in chunks.

```APIDOC
## Streaming Download

### Description
This example demonstrates how to use the `ByteStream` abstraction to download large files by processing the response body in chunks, preventing memory overflow.

### Usage
```rust
use jacquard_common::http_client::{HttpClient, HttpClientExt};
use futures_lite::StreamExt;

let client = reqwest::Client::new();
let request = http::Request::builder()
    .uri("https://example.com/large-file")
    .body(vec![])
    .unwrap();

let response = client.send_http_streaming(request).await?;
let (_parts, body) = response.into_parts();
let mut stream = Box::pin(body.into_inner());

while let Some(chunk) = stream.as_mut().try_next().await? {
    // Process chunk without loading entire file into memory
}
```
```
Tokens:
Raw