Struct wicrs_server::hub::HubMember

pub struct HubMember {
    pub user: ID,
    pub joined: DateTime<Utc>,
    pub hub: ID,
    pub nickname: String,
    pub groups: Vec<ID>,
    pub hub_permissions: HubPermissions,
    pub channel_permissions: HashMap<ID, ChannelPermissions>,
}

Represents a member of a hub that maps to a user.

Fields

user: ID

ID of the user that the hub member represents.

joined: DateTime<Utc>

Time in milliseconds since Unix Epoch that the user became a member of the hub.

hub: ID

ID of the hub that this hub member is in.

nickname: String

Name used by the hub member.

groups: Vec<ID>

Groups that the hub member is part of.

hub_permissions: HubPermissions

Hub permission settings that the hub member has.

channel_permissions: HashMap<ID, ChannelPermissions>

Mapping of channel permission settings the hub member has to the channel they apply to.

Implementations

impl HubMember

pub fn new(user: &User, hub: ID) -> Self

Creates a new hub member based on a user and the ID of the hub they are part of.

pub fn set_nickname(&mut self, nickname: String) -> Result

Changes the nickname of the hub member or returns an error if check_name_validity fails.

pub fn join_group(&mut self, group: &mut PermissionGroup)

Adds the hub member to a permission group.

pub fn leave_group(&mut self, group: &mut PermissionGroup)

Removes the hub member from a permission group.

pub fn set_permission(
    &mut self,
    permission: HubPermission,
    value: PermissionSetting
)

Sets a hub permission for the hub member.

pub fn set_channel_permission(
    &mut self,
    channel: &ID,
    permission: ChannelPermission,
    value: PermissionSetting
)

Sets a channel permission for the hub member in the specified channel.

pub fn has_all_permissions(&self) -> bool

Checks if the hub member has the HubPermission::All permission or if they inherit it from a permission group they are in.

pub fn has_permission(&self, permission: HubPermission, hub: &Hub) -> bool

Checks if the hub member has the given hub permission or if they inherit it from a permission group they are in.

pub fn has_channel_permission(
    &self,
    channel: &ID,
    permission: ChannelPermission,
    hub: &Hub
) -> bool

Checks if the hub member has the given channel permission in the given channel or if they inherit it from a permission group they are in.

Trait Implementations

impl Clone for HubMember

fn clone(&self) -> HubMember

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainerType for HubMember

fn resolve_field<'life0, 'life1, 'life2, 'async_trait>(
    &'life0 self,
    ctx: &'life1 Context<'life2>
) -> Pin<Box<dyn Future<Output = ServerResult<Option<Value>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    Self: 'async_trait, 

Resolves a field value and outputs it as a json value async_graphql::Value.

fn find_entity<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    ctx: &'life1 Context<'life2>,
    params: &'life3 Value
) -> Pin<Box<dyn Future<Output = ServerResult<Option<Value>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

Find the GraphQL entity with the given name from the parameter.

pub fn collect_all_fields(
    &'a self,
    ctx: &ContextBase<'a, &'a Positioned<SelectionSet>>,
    fields: &mut Fields<'a>
) -> Result<(), ServerError> where
    Self: Send + Sync, 

Collect all the fields of the container that are queried in the selection set.

impl Debug for HubMember

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HubMember

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl ObjectType for HubMember

impl OutputType for HubMember

fn resolve<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    ctx: &'life1 ContextSelectionSet<'life2>,
    _field: &'life3 Positioned<Field>
) -> Pin<Box<dyn Future<Output = ServerResult<Value>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: 'async_trait, 

Resolve an output value to async_graphql::Value.

impl PartialEq<HubMember> for HubMember

fn eq(&self, other: &HubMember) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HubMember) -> bool

This method tests for !=.

impl Serialize for HubMember

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HubMember

impl Type for HubMember

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

pub fn qualified_type_name() -> String

Qualified typename.

pub fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name