Struct wicrs_server::user::User

pub struct User {
    pub id: ID,
    pub status: String,
    pub description: String,
    pub username: String,
    pub email: String,
    pub created: DateTime<Utc>,
    pub service: Service,
    pub in_hubs: Vec<ID>,
}

Represents a user of WICRS.

Fields

id: ID

ID of the user.

status: String

The user’s status.

description: String

The user’s description.

username: String

The user’s name.

email: String

The email address used by the user on their OAuth service.

created: DateTime<Utc>

Time of creation of the user in milliseconds from Unix Epoch.

service: Service

The OAuth service the user used to sign up.

in_hubs: Vec<ID>

A list of the hubs that the user is a member of.

Implementations

impl User

pub async fn id(&self, ctx: &Context<'_>) -> Result<&ID>

pub async fn status(&self, ctx: &Context<'_>) -> Result<&String>

pub async fn description(&self, ctx: &Context<'_>) -> Result<&String>

pub async fn username(&self, ctx: &Context<'_>) -> Result<&String>

pub async fn email(&self, ctx: &Context<'_>) -> Result<&String>

pub async fn created(&self, ctx: &Context<'_>) -> Result<&DateTime<Utc>>

pub async fn service(&self, ctx: &Context<'_>) -> Result<&Service>

pub async fn in_hubs(&self, ctx: &Context<'_>) -> Result<&Vec<ID>>

impl User

pub fn new(id: String, email: String, service: Service) -> Self

Creates a new user and generates an ID by hashing the service used and the ID of the user according to that service.

pub fn to_generic(&self, requester_id: &ID) -> GenericUser

Converts the standard user into a GenericUser, the hashed versions of the hub ID list also use the requester’s ID to avoid hash lists or rainbow tables being used.

pub fn join_hub(&mut self, hub: &mut Hub) -> Result

Adds the user to the hub with the given ID, giving them the default permissions and making sure that they are not banned.

Errors

This function will return an error in the following situations, but is not limited to just these cases:

• Thu hub does not exist.
• The user is banned from the hub.
• The user could not be added to the hub for any of the reasons outlined in Hub::user_join.
• The hub failed to load for any of the reasons outlined in Hub::load.
• The hub failed to save for any of the reasons outlined in Hub::save.

pub fn remove_hub(&mut self, hub_id: &ID) -> Result

Removes the user from the hub with the given ID.

Errors

This function will return an error in the following situations, but is not limited to just these cases:

• The user is not a member of the given hub.

pub async fn save(&self) -> Result

Saves the user’s data to a file on the disk.

pub async fn load(id: &ID) -> Result<Self>

Loads the data of the user with the given ID.

Errors

This function will return an error in the following situations, but is not limited to just these cases:

• The user data file could not be found, probably means that the user does not exist.
• The user data file was corrupt and or could not be deserialized properly.

pub async fn load_get_id(id: &str, service: &Service) -> Result<Self>

Same as Self::load but first maps an OAuth ID and service name to a WICRS Server ID.

Arguments

• id - the ID of the user on their selected OAuth service.
• service - the user’s selected OAuth service.

Errors

This function will return an error in the same situations outlined by User::load

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainerType for User

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.

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.

#[must_use]

pub fn find_entity<'life0, 'life1, 'life2, 'life3, 'async_trait>(
    &'life0 self,
    __arg1: &'life1 ContextBase<'life2, &'life2 Positioned<Field>>,
    _params: &'life3 ConstValue
) -> Pin<Box<dyn Future<Output = Result<Option<ConstValue>, ServerError>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    'life2: 'async_trait,
    'life3: 'async_trait,
    Self: Sync + 'async_trait, 

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

impl Debug for User

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for User

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

Deserialize this value from the given Serde deserializer.

impl ObjectType for User

impl OutputType for User

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<User> for User

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

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

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

This method tests for !=.

impl Serialize for User

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 User

impl Type for User

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