pub struct GroupSubgroupsBuilder<'a> { /* private fields */ }
Expand description
Builder for GroupSubgroups
.
Implementations§
source§impl<'a> GroupSubgroupsBuilder<'a>
impl<'a> GroupSubgroupsBuilder<'a>
sourcepub fn group<VALUE: Into<NameOrId<'a>>>(&mut self, value: VALUE) -> &mut Self
pub fn group<VALUE: Into<NameOrId<'a>>>(&mut self, value: VALUE) -> &mut Self
The group to query for subgroups.
sourcepub fn all_available(&mut self, value: bool) -> &mut Self
pub fn all_available(&mut self, value: bool) -> &mut Self
Show all the groups you have access to (defaults to false for authenticated users, true for admin); Attributes owned and min_access_level have precedence.
sourcepub fn search<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self
pub fn search<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self
Search for subgroup using a query string.
The search query will be escaped automatically.
sourcepub fn order_by(&mut self, value: GroupSubgroupsOrderBy) -> &mut Self
pub fn order_by(&mut self, value: GroupSubgroupsOrderBy) -> &mut Self
Return subgroups ordered by keys.
sourcepub fn sort(&mut self, value: SortOrder) -> &mut Self
pub fn sort(&mut self, value: SortOrder) -> &mut Self
Return subgroups sorted in asc or desc order.
sourcepub fn statistics(&mut self, value: bool) -> &mut Self
pub fn statistics(&mut self, value: bool) -> &mut Self
Include group statistics (admins only).
sourcepub fn with_custom_attributes(&mut self, value: bool) -> &mut Self
pub fn with_custom_attributes(&mut self, value: bool) -> &mut Self
Include custom attributes in response (admins only).
sourcepub fn owned(&mut self, value: bool) -> &mut Self
pub fn owned(&mut self, value: bool) -> &mut Self
Limit by subgroups owned by the current user.
sourcepub fn min_access_level(&mut self, value: AccessLevel) -> &mut Self
pub fn min_access_level(&mut self, value: AccessLevel) -> &mut Self
Limit to subgroups where current user has at least this access level.
sourcepub fn build(&self) -> Result<GroupSubgroups<'a>, GroupSubgroupsBuilderError>
pub fn build(&self) -> Result<GroupSubgroups<'a>, GroupSubgroupsBuilderError>
source§impl<'a> GroupSubgroupsBuilder<'a>
impl<'a> GroupSubgroupsBuilder<'a>
sourcepub fn skip_group(&mut self, group_id: u64) -> &mut Self
pub fn skip_group(&mut self, group_id: u64) -> &mut Self
Filter results by skipping the given group ID.
sourcepub fn skip_groups<I>(&mut self, iter: I) -> &mut Selfwhere
I: Iterator<Item = u64>,
pub fn skip_groups<I>(&mut self, iter: I) -> &mut Selfwhere I: Iterator<Item = u64>,
Filter results by skipping the given group IDs.
Trait Implementations§
source§impl<'a> Clone for GroupSubgroupsBuilder<'a>
impl<'a> Clone for GroupSubgroupsBuilder<'a>
source§fn clone(&self) -> GroupSubgroupsBuilder<'a>
fn clone(&self) -> GroupSubgroupsBuilder<'a>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl<'a> RefUnwindSafe for GroupSubgroupsBuilder<'a>
impl<'a> Send for GroupSubgroupsBuilder<'a>
impl<'a> Sync for GroupSubgroupsBuilder<'a>
impl<'a> Unpin for GroupSubgroupsBuilder<'a>
impl<'a> UnwindSafe for GroupSubgroupsBuilder<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more