Struct SearchApi 

pub struct SearchApi<'a> { /* private fields */ }

Sub-API for search endpoints.

Implementations

impl<'a> SearchApi<'a>

pub async fn do_search( &self, request: DoSearchRequest, ) -> Result<Value, RsError>

Performs a search and returns matching resources.

Arguments

• request - Parameters built via DoSearchRequest

TODO: Errors

Returns RsError::OperationFailed if the search returns no results or the user lacks search permissions.

Examples

let results = client.search()
    .do_search(DoSearchRequest::new("cat").sort(SortOrder::Desc))
    .await?;

let specific_results = client.search()
    .do_search(
        DoSearchRequest::new("cat")
            .fetchrows("100")
            .offset(50)
            .archive(0)
    )
    .await?;

Examples found in repository

examples/basic.rs (line 27)

async fn main() {
    dotenvy::from_path("examples/.env").ok();

    let base_url = std::env::var("RS_BASE_URL").expect("RS_BASE_URL not set");
    let user = std::env::var("RS_USER").expect("RS_USER not set");
    let _password = std::env::var("RS_PASS").expect("RS_PASS not set");
    let key = std::env::var("RS_KEY").expect("RS_KEY not set");

    let client = Client::builder()
        .base_url(&base_url)
        .expect("Error when setting base_url")
        .user_key(&user, &key)
        // .session_key(&user, &password)
        .build()
        .await
        .expect("Error when building client");

    let search_result = client
        .search()
        .do_search(DoSearchRequest::new("909").sort(SortOrder::Asc))
        .await;

    match search_result {
        Ok(response) => println!("{:#?}", response),
        Err(e) => println!("Error: {}", e),
    }

    let system_result = client
        .system()
        .get_daily_stat_summary(GetDailyStatSummaryRequest::new().days(31))
        .await;

    match system_result {
        Ok(response) => println!("{:#?}", response),
        Err(e) => println!("Error: {}", e),
    }

    let message_result = client
        .message()
        .get_user_message(GetUserMessageRequest::new(12))
        .await;

    match message_result {
        Ok(response) => println!("{:#?}", response),
        Err(e) => println!("Error: {}", e),
    }
}

pub async fn search_get_previews( &self, request: SearchGetPreviewsRequest, ) -> Result<Value, RsError>

Performs a search and returns matching resources including URLs for requested preview sizes.

Arguments

• request - Parameters built via SearchGetPreviewsRequest

TODO: Errors

Returns RsError::OperationFailed if the search returns no results or the user lacks search permissions.

Examples

let results = client.search()
    .search_get_previews(SearchGetPreviewsRequest::new("cat").getsizes("thm,scr"))
    .await?;

let specific_results = client.search()
    .search_get_previews(
        SearchGetPreviewsRequest::new("cat")
            .getsizes("thm,scr,pre")
            .previewext("jpg")
            .sort(SortOrder::Desc)
            .fetchrows("0,50")
    )
    .await?;

Trait Implementations

impl<'a> Debug for SearchApi<'a>

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

Formats the value using the given formatter.