Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Third Party Crates

Querying methods on types from external crates.

Note

The first time you query a third-party type, Cargo must download and compile the crate inside the ephemeral probe project. This can take 10-30 seconds on a cold cache. Subsequent queries still require Cargo to resolve dependencies inside the ephemeral probe project, so expect similar times on every invocation until persistent probe caching is implemented.

third_party_crate.rs

use rust_meth_lib::analyzer::{find_rust_analyzer, query_methods};

fn main() -> rust_meth_lib::error::Result<()> {
    let ra_path = find_rust_analyzer()?;

    // ── Single external crate ────────────────────────────────────────────────

    let serde_deps = r#"serde_json = "1.0""#;

    println!("Querying serde_json::Value methods (may be slow on first run)...");
    let methods = query_methods("serde_json::Value", &ra_path, Some(serde_deps))?;

    println!("serde_json::Value has {} methods:", methods.len());
    for m in &methods {
        println!("  {}", m.name);
    }

    println!();

    // ── Multiple dependencies ────────────────────────────────────────────────
    //
    // If your type requires more than one crate (e.g. a type that uses serde
    // traits), pass all deps as a single newline-separated string. This maps
    // directly to what Cargo expects under [dependencies].

    let multi_deps = "serde = { version = \"1.0\", features = [\"derive\"] }\nserde_json = \"1.0\"";

    println!("Querying serde_json::Map with serde + serde_json...");
    let map_methods = query_methods(
        "serde_json::Map<String, serde_json::Value>",
        &ra_path,
        Some(multi_deps),
    )?;

    println!("serde_json::Map has {} methods:", map_methods.len());
    for m in &map_methods {
        println!("  {}", m.name);
    }

    Ok(())
}

Output

Querying serde_json::Value methods (may be slow on first run)...
serde_json::Value has 37 methods:
  as_array
  as_array_mut
  as_bool
  as_f64
  as_i64
  as_null
  as_number
  as_object
  as_object_mut
  as_str
  as_u64
  clone
  clone_from
  clone_into
  eq
  get
  get_mut
  index
  index_mut
  into
  is_array
  is_boolean
  is_f64
  is_i64
  is_null
  is_number
  is_object
  is_string
  is_u64
  ne
  pointer
  pointer_mut
  sort_all_objects
  take
  to_owned
  to_string
  try_into

Querying serde_json::Map with serde + serde_json...
serde_json::Map has 34 methods:
  append
  clear
  clone
  clone_from
  clone_into
  contains_key
  entry
  eq
  extend
  extend_one
  extend_reserve
  get
  get_key_value
  get_mut
  index
  index_mut
  insert
  into
  into_iter
  into_values
  is_empty
  iter
  iter_mut
  keys
  len
  ne
  remove
  remove_entry
  retain
  sort_keys
  to_owned
  try_into
  values
  values_mut

Using the Builder API

The same queries using MethodQuery, the .deps() call keeps the dependency string attached to the type it belongs to:

use rust_meth_lib::analyzer::find_rust_analyzer;
use rust_meth_lib::query::MethodQuery;

fn main() -> rust_meth_lib::error::Result<()> {
    let ra_path = find_rust_analyzer()?;

    let methods = MethodQuery::new("serde_json::Value")
        .deps(r#"serde_json = "1.0""#)
        .run(&ra_path)?;

    println!("serde_json::Value has {} methods:", methods.len());
    for m in &methods {
        println!("  {}", m.name);
    }

    println!();

    let map_methods = MethodQuery::new("serde_json::Map<String, serde_json::Value>")
        .deps("serde = { version = \"1.0\", features = [\"derive\"] }\nserde_json = \"1.0\"")
        .run(&ra_path)?;

    println!("serde_json::Map has {} methods:", map_methods.len());
    for m in &map_methods {
        println!("  {}", m.name);
    }

    Ok(())
}

Output is identical to the above.