Struct misskey_api::endpoint::users::search::Request

pub struct Request {
    pub query: String,
    pub local_only: Option<bool>,
    pub detail: Option<bool>,
    pub limit: Option<u8>,
    pub offset: Option<u64>,
}

Fields

query: String

local_only: Option<bool>

detail: Option<bool>

limit: Option<u8>

1 .. 100

offset: Option<u64>

Implementations

impl Request

pub fn builder() -> RequestBuilder<((), (), (), (), ())>

Create a builder for building Request. On the builder, call .query(...), .local_only(...)(optional), .detail(...)(optional), .limit(...)(optional), .offset(...)(optional) to set the values of the fields (they accept Into values). Finally, call .build() to create the instance of Request.

Trait Implementations

impl Clone for Request

pub fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl OffsetPaginationRequest for Request

type Item = User

The paginated item type.

pub fn set_offset(&mut self, offset: u64)

Sets the offset field of the request.

pub fn set_limit(&mut self, limit: u8)

Sets the limit field of the request.

impl Request for Request

type Response = Vec<User>

Response type of this request.

pub const ENDPOINT: &'static str

The name of the corresponding endpoint.

impl Serialize for Request

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

Serialize this value into the given Serde serializer.