Struct DoSearchRequest 

pub struct DoSearchRequest {
    pub search: String,
    pub restypes: Option<List<u32>>,
    pub order_by: Option<String>,
    pub archive: Option<i8>,
    pub fetchrows: Option<FetchRows>,
    pub sort: Option<SortOrder>,
    pub offset: Option<u32>,
}

Fields

search: String

The search string to match resources against.

restypes: Option<List<u32>>

Comma-separated list of resource type IDs to restrict results to.

order_by: Option<String>

Field name to order results by.

archive: Option<i8>

Archive status filter: 0 = live, 1 = archived, 2 = deleted.

fetchrows: Option<FetchRows>

Number of rows to return, or "offset,rows" for paginated fetching.

sort: Option<SortOrder>

Sort direction for the results.

offset: Option<u32>

Number of results to skip, used for pagination.

Implementations

impl DoSearchRequest

pub fn new(search: impl Into<String>) -> Self

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 fn restypes(self, restypes: impl Into<List<u32>>) -> Self

pub fn order_by(self, order_by: impl Into<String>) -> Self

pub fn archive(self, archive: i8) -> Self

pub fn fetchrows(self, fetchrows: FetchRows) -> Self

pub fn sort(self, sort: SortOrder) -> Self

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 fn offset(self, offset: u32) -> Self

Trait Implementations

impl Clone for DoSearchRequest

fn clone(&self) -> DoSearchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DoSearchRequest

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

Formats the value using the given formatter.

impl PartialEq for DoSearchRequest

fn eq(&self, other: &DoSearchRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DoSearchRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DoSearchRequest