Struct Search 

pub struct Search {
    pub client: Client,
}

Available on crate feature requests only.

Fields

client: Client

Implementations

impl Search

pub async fn retrieve<'a>( &'a self, db_only: Option<bool>, query: &'a str, ) -> Result<SearchResult, Error>

Perform a GET request to /api/search/.

Global search

Parameters:

• db_only: Option<bool>: Search only the database
• query: &'astr: Query to search for (required)

async fn example_search_retrieve() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: paperless_api_client::types::SearchResult =
        client.search().retrieve(Some(true), "some-string").await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn autocomplete_list<'a>( &'a self, limit: Option<i64>, term: Option<String>, ) -> Result<Vec<String>, Error>

Perform a GET request to /api/search/autocomplete/.

Get a list of all available tags

Parameters:

• limit: Option<i64>: Number of completions to return
• term: Option<String>: Term to search for

async fn example_search_autocomplete_list() -> anyhow::Result<()> {
    let client = paperless_api_client::Client::new_from_env();
    let result: Vec<String> = client
        .search()
        .autocomplete_list(Some(4 as i64), Some("some-string".to_string()))
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Search

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.