SearchRequest

Struct SearchRequest 

Source
pub struct SearchRequest {
    pub search_type: SearchRequestType,
    pub query: String,
    pub count: Option<u32>,
    pub page: Option<u32>,
    pub lang: Option<String>,
    pub topic_id: Option<u32>,
    pub get_tags: bool,
    pub get_creator: bool,
    pub get_stats: bool,
    pub get_tags_for_topic: bool,
    pub get_stats_for_topic: bool,
    pub include_empty_topics: bool,
}
Expand description

Perform a search.

Maps parameters of https://www.scoop.it/dev/api/1/urls#search

Documentation of each field comes from the page above. Default values documented are used only ff the field is not present (None), Default implementation for this struct may differ from Scoop.it defaults to avoid retrieving the world while only looking at the user profile.

Fields§

§search_type: SearchRequestType

string - type of object searched: “user”, “topic” or “post”

§query: String

string - the search query

§count: Option<u32>

int optional, default to 50 - the number of item per page

§page: Option<u32>

int optional, default to 0 -the page number to return, the first page is 0

§lang: Option<String>

string optional, default to “en” - the language of the content to search into

§topic_id: Option<u32>

long optional - the id of the topic to search posts into

§get_tags: bool

bool optional, default to true - returns or not list of tags for each returned topic / post. only for type=“topic” or type=“post”

§get_creator: bool

bool optional, default to true - returns or not creator of each returned topic. only for type=“topic”

§get_stats: bool

bool optional, default to true - returns or not stats for each returned topic. only for type=“topic”

§get_tags_for_topic: bool

bool optional, default to true - returns or not tags for topic of each returned post. only for type=“post”

§get_stats_for_topic: bool

bool optional, default to true - returns or not stats for topic of each returned post. only for type=“post”

§include_empty_topics: bool

bool optional, default to false - also returns topics having no posts. only for type=“topic”

Trait Implementations§

Source§

impl Debug for SearchRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SearchRequest

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl GetRequest for SearchRequest

Source§

type Response = SearchResponse

The type returned by the Scoop.it API. Read more
Source§

type Output = SearchResults

The type returned by the client
Source§

fn endpoint(&self) -> Cow<'static, str>

Source§

impl Serialize for SearchRequest

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more