Struct RustAssistant

pub struct RustAssistant { /* private fields */ }

The RustAssistant struct, providing functionalities to interact with crates and their contents.

This struct encapsulates methods for downloading crates, reading their content, and performing searches within them.

Implementations

impl RustAssistant

pub async fn get_crate(&self, crate_version: &CrateVersion) -> Result<Crate>

Retrieves a crate from the cache or downloads it if not already cached.

Arguments

• crate_version - A reference to CrateVersion specifying the crate to retrieve.

Returns

A Result wrapping the Crate, or an error if the operation fails.

pub async fn get_file_content( &self, crate_version_path: &CrateVersionPath, file_line_range: FileLineRange, ) -> Result<Option<FileContent>>

Retrieves the content of a file within a specified crate and range.

Arguments

• crate_version_path - A reference to CrateVersionPath specifying the crate and file path.
• file_line_range - A FileLineRange specifying the range of lines to retrieve.

Returns

A Result wrapping an Option<CrateFileContent>, or an error if the operation fails.

pub async fn read_directory( &self, crate_version_path: CrateVersionPath, ) -> Result<Option<Directory>>

Reads the content of a directory within a specified crate.

Arguments

• crate_version_path - A CrateVersionPath specifying the crate and directory path.

Returns

A Result wrapping an Option<Directory>, or an error if the operation fails.

pub async fn search_item( &self, crate_version: &CrateVersion, query: impl Into<ItemQuery>, ) -> Result<Vec<Item>>

Searches for items in a crate based on a query.

Arguments

• crate_version - A reference to CrateVersion specifying the crate to search in.
• query - An ItemQuery specifying the search criteria.

Returns

A Result wrapping a Vec<Item>, or an error if the operation fails.

pub async fn search_line( &self, crate_version: &CrateVersion, query: impl Into<LineQuery>, ) -> Result<Vec<Line>>

Searches for lines in a crate’s files based on a query.

Arguments

• crate_version - A reference to CrateVersion specifying the crate to search in.
• query - A LineQuery specifying the search criteria.

Returns

A Result wrapping a Vec<Line>, or an error if the operation fails.

pub async fn read_github_repository_file( &self, repo: &Repository, path: &str, branch: impl Into<Option<&str>>, ) -> Result<Option<FileContent>>

Reads the content of a file within a specified GitHub repository.

Arguments

• repo - A reference to Repository specifying the GitHub repository.
• path - A &str specifying the file path.
• branch - An optional &str specifying the branch name.

Returns

A Result wrapping a FileContent, or an error if the operation fails.

pub async fn read_github_repository_directory( &self, repo: &Repository, path: &str, branch: impl Into<Option<&str>>, ) -> Result<Option<Directory>>

Reads the content of a directory within a specified GitHub repository.

Arguments

• repo - A reference to Repository specifying the GitHub repository.
• path - A &str specifying the directory path.
• branch - An optional &str specifying the branch name.

Returns

A Result wrapping a Directory, or an error if the operation fails.

pub async fn search_github_repository_for_issues( &self, repo: &Repository, query: &str, ) -> Result<Vec<Issue>>

Searches for issues in a specified GitHub repository based on a query.

Arguments

• repo - A reference to Repository specifying the GitHub repository.
• query - A &str specifying the query string.

Returns

A Result wrapping a Vec<Issue>, or an error if the operation fails.

pub async fn get_github_repository_issue_timeline( &self, repo: &Repository, issue_number: u64, ) -> Result<Vec<IssueEvent>>

Retrieves the timeline of an issue in a specified GitHub repository.

Arguments

• repo - A reference to Repository specifying the GitHub repository.
• issue_number - A u64 specifying the issue number.

Returns

A Result wrapping a Vec<IssueEvent>, or an error if the operation fails.

pub async fn get_github_repository_branches( &self, repo: &Repository, ) -> Result<Vec<String>>

Retrieves the branches of a specified GitHub repository.

Trait Implementations

impl Clone for RustAssistant

fn clone(&self) -> RustAssistant

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<(CrateDownloader, CrateCache, GithubClient)> for RustAssistant

fn from( (downloader, cache, github): (CrateDownloader, CrateCache, GithubClient), ) -> Self

Creates a new RustAssistant instance from a tuple of dependencies.