Struct UsersBuilder

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

Builder for Users.

Implementations

impl<'a> UsersBuilder<'a>

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

Search for users using a query string.

The search query will be escaped automatically.

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

Get a user with a given username.

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

Return only active users.

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

Return only blocked users.

pub fn external_provider(&mut self, value: ExternalProvider<'a>) -> &mut Self

Search for a user with a given external provider identity.

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

Whether to return external users or not.

pub fn created_before(&mut self, value: DateTime<Utc>) -> &mut Self

Return users created before a given date.

pub fn created_after(&mut self, value: DateTime<Utc>) -> &mut Self

Return users created after a given date.

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

Provide custom attributes as well.

pub fn order_by(&mut self, value: UserOrderBy) -> &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 two_factor<VALUE: Into<EnableState>>( &mut self, value: VALUE, ) -> &mut Self

Return users with a two-factor enabled or not.

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

If set to true, filter out users without any projects.

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

If set to true, filter out bot users for projects.

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

If set to true, exclude active users.

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

If set to true, exclude “human” users.

All users that are not bots or internal are considered “human”.

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

If set to true, only include “human” users.

All users that are not bots or internal are considered “human”.

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

Exclude internal users.

These are generally Service Desk users or other GitLab-managed users.

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

Exclude external users.

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

Filter urses based on administrator status.

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

Filter users based on auditor status.

pub fn saml_provider_id(&mut self, value: u64) -> &mut Self

If provided, only return users created by the given SAML provider ID.

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

If set, skip LDAP user lookups.

pub fn build(&self) -> Result<Users<'a>, UsersBuilderError>

Builds a new Users.

Errors

If a required field has not been initialized.

impl<'a> UsersBuilder<'a>

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 UsersBuilder<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Default for UsersBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.