Struct SearchRepositoriesBuilder

pub struct SearchRepositoriesBuilder {

    pub query: Option<String>,
    pub topic: Option<bool>,
    pub include_desc: Option<bool>,
    pub uid: Option<i64>,
    pub priority_owner_id: Option<i64>,
    pub team_id: Option<i64>,
    pub starred_by: Option<i64>,
    pub private: Option<bool>,
    pub is_private: Option<bool>,
    pub template: Option<bool>,
    pub archived: Option<bool>,
    pub mode: Option<String>,
    pub exclusive: Option<bool>,
    pub sort: Option<String>,
    pub order: Option<String>,
    pub page: Option<i32>,
    pub limit: Option<i32>,
}

Options for searching repositories. All fields are optional.

Fields

query: Option<String>

Keyword to search for

topic: Option<bool>

Limit search to repositories with keyword as topic

include_desc: Option<bool>

Include search of keyword within repository description

uid: Option<i64>

Search only for repos that the user with the given id owns or contributes to

priority_owner_id: Option<i64>

Repo owner to prioritize in the results

team_id: Option<i64>

Search only for repos that belong to the given team id

starred_by: Option<i64>

Search only for repos that the user with the given id has starred

private: Option<bool>

Include private repositories this user has access to (defaults to true)

is_private: Option<bool>

Show only pubic, private or all repositories (defaults to all)

template: Option<bool>

Include template repositories this user has access to (defaults to true)

archived: Option<bool>

Show only archived, non-archived or all repositories (defaults to all)

mode: Option<String>

Type of repository to search for. Supported values are “fork”, “source”, “mirror” and “collaborative”

exclusive: Option<bool>

If uid is given, search only for repos that the user owns

sort: Option<String>

Sort repos by attribute. Supported values are “alpha”, “created”, “updated”, “size”, and “id”. Default is “alpha”

order: Option<String>

Sort order, either “asc” (ascending) or “desc” (descending). Default is “asc”, ignored if “sort” is not specified.

page: Option<i32>

Page number of results to return (1-based)

limit: Option<i32>

Page size of results

Implementations

impl SearchRepositoriesBuilder

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

Keyword to search for

pub fn topic(self, topic: impl Into<bool>) -> Self

Limit search to repositories with keyword as topic

pub fn include_desc(self, include_desc: impl Into<bool>) -> Self

Include search of keyword within repository description

pub fn uid(self, uid: impl Into<i64>) -> Self

Search only for repos that the user with the given id owns or contributes to

pub fn priority_owner_id(self, priority_owner_id: impl Into<i64>) -> Self

Repo owner to prioritize in the results

pub fn team_id(self, team_id: impl Into<i64>) -> Self

Search only for repos that belong to the given team id

pub fn starred_by(self, starred_by: impl Into<i64>) -> Self

Search only for repos that the user with the given id has starred

pub fn private(self, private: impl Into<bool>) -> Self

Include private repositories this user has access to (defaults to true)

pub fn is_private(self, is_private: impl Into<bool>) -> Self

Show only pubic, private or all repositories (defaults to all)

pub fn template(self, template: impl Into<bool>) -> Self

Include template repositories this user has access to (defaults to true)

pub fn archived(self, archived: impl Into<bool>) -> Self

Show only archived, non-archived or all repositories (defaults to all)

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

Type of repository to search for. Supported values are “fork”, “source”, “mirror” and “collaborative”

pub fn exclusive(self, exclusive: impl Into<bool>) -> Self

If uid is given, search only for repos that the user owns

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

Sort repos by attribute. Supported values are “alpha”, “created”, “updated”, “size”, and “id”. Default is “alpha”

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

Sort order, either “asc” (ascending) or “desc” (descending). Default is “asc”, ignored if “sort” is not specified.

pub fn page(self, page: impl Into<i32>) -> Self

Page number of results to return (1-based)

pub fn limit(self, limit: impl Into<i32>) -> Self

Page size of results

impl SearchRepositoriesBuilder

pub fn new() -> Self

pub async fn send(&self, client: &Client) -> Result<Vec<Repository>>

Trait Implementations

impl Clone for SearchRepositoriesBuilder

fn clone(&self) -> SearchRepositoriesBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRepositoriesBuilder

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

Formats the value using the given formatter.

impl Default for SearchRepositoriesBuilder

fn default() -> SearchRepositoriesBuilder

Returns the “default value” for a type.

impl Serialize for SearchRepositoriesBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.