Struct gitlab::api::groups::GroupsBuilder

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

Builder for Groups.

Implementations

impl<'a> GroupsBuilder<'a>

pub fn search<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

Search for groups using a query string.

The search query will be escaped automatically.

pub fn all_available(&mut self, value: bool) -> &mut Self

Show all groups with access.

Note that the default for this endpoint differs based on whether the API caller has administrator privileges or not.

pub fn owned(&mut self, value: bool) -> &mut Self

Filter owned by those owned by the API caller.

pub fn min_access_level(&mut self, value: AccessLevel) -> &mut Self

Filter groups by those where the API caller has a minimum access level.

pub fn top_level_only(&mut self, value: bool) -> &mut Self

Only return top-level groups.

pub fn repository_storage<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE ) -> &mut Self

The storage shard used by the group.

pub fn statistics(&mut self, value: bool) -> &mut Self

Include project statistics in the results.

pub fn with_custom_attributes(&mut self, value: bool) -> &mut Self

Include custom attributes in the response.

pub fn order_by(&mut self, value: GroupOrderBy) -> &mut Self

Order results by a given key.

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

The sort order for returned results.

pub fn build(&self) -> Result<Groups<'a>, GroupsBuilderError>

Builds a new Groups.

Errors

If a required field has not been initialized.

impl<'a> GroupsBuilder<'a>

pub fn skip_group(&mut self, group: u64) -> &mut Self

Skip the given group ID.

pub fn skip_groups<I>(&mut self, iter: I) -> &mut Self

where I: Iterator<Item = u64>,

Skip the given group IDs.

pub fn custom_attribute<K, V>(&mut self, key: K, value: V) -> &mut Self

where K: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Add a custom attribute search parameter.

pub fn custom_attributes<I, K, V>(&mut self, iter: I) -> &mut Self

where I: Iterator<Item = (K, V)>, K: Into<Cow<'a, str>>, V: Into<Cow<'a, str>>,

Add multiple custom attribute search parameters.

Trait Implementations

impl<'a> Clone for GroupsBuilder<'a>

fn clone(&self) -> GroupsBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for GroupsBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.