Skip to main content

UpdateUser

Struct UpdateUser 

Source
pub struct UpdateUser<'a> {
    pub project_id: &'a str,
    pub user_key: &'a str,
    pub identifier: Option<&'a str>,
    pub auth_expire: Option<OffsetDateTime>,
    pub note: Option<&'a str>,
    pub discord_id: Option<&'a str>,
}
Expand description

Update fields of an already existing user.

⚠️ Authenticated ⚠️

Reference

Fields§

§project_id: &'a str

The associated project ID that contains the key.

§user_key: &'a str

The user key to update.

§identifier: Option<&'a str>

A unique identifier for the key, usually their HWID.

§auth_expire: Option<OffsetDateTime>

The unix timestamp of when the key should expire.

NOTE: if this is not defined, the key will never expire; read the struct comments for more information.

§note: Option<&'a str>

A custom note for the key, which can be used to identify the user and key or provide additional information about them.

§discord_id: Option<&'a str>

The Discord ID associated with the key. However if you set up the Discord bot, the user can manually redeem their key and link it via the “Redeem” button on the panel.

NOTE: if a Discord ID is not associated with a key, the user cannot use the /resethwid discord command.

Implementations§

Source§

impl<'a> UpdateUser<'a>

Source

pub fn builder() -> UpdateUserBuilder<'a, ((), (), (), (), (), ())>

Create a builder for building UpdateUser. On the builder, call .project_id(...), .user_key(...), .identifier(...)(optional), .auth_expire(...)(optional), .note(...)(optional), .discord_id(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of UpdateUser.

Trait Implementations§

Source§

impl<'a> Clone for UpdateUser<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for UpdateUser<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for UpdateUser<'a>

Source§

fn default() -> UpdateUser<'a>

Returns the “default value” for a type. Read more
Source§

impl Endpoint for UpdateUser<'_>

Source§

fn method(&self) -> Method

The method for the endpoint.
Source§

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

The path for the endpoint.
Source§

fn body(&self) -> Result<Option<(Cow<'static, str>, Vec<u8>)>, BodyError>

The body for the endpoint. Read more
Source§

fn ignore_errors(&self) -> bool

Ignores any errors returned by the API.
Source§

fn headers(&self) -> Result<Option<HeaderMap>, HeaderError>

Any additional headers for the endpoint.
Source§

fn query_params(&self) -> Option<QueryParamPairs>

The query parameters for the endpoint.
Source§

fn url(&self) -> String

Builds the full URL, including query.
Source§

fn deserialize<T>(&self, response: Response<Bytes>) -> Result<T, BodyError>

Deserialize the response bytes. Read more
Source§

impl<'a> Hash for UpdateUser<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> Ord for UpdateUser<'a>

Source§

fn cmp(&self, other: &UpdateUser<'a>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<'a> PartialEq for UpdateUser<'a>

Source§

fn eq(&self, other: &UpdateUser<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> PartialOrd for UpdateUser<'a>

Source§

fn partial_cmp(&self, other: &UpdateUser<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a> Serialize for UpdateUser<'a>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> Copy for UpdateUser<'a>

Source§

impl<'a> Eq for UpdateUser<'a>

Source§

impl<'a> StructuralPartialEq for UpdateUser<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for UpdateUser<'a>

§

impl<'a> RefUnwindSafe for UpdateUser<'a>

§

impl<'a> Send for UpdateUser<'a>

§

impl<'a> Sync for UpdateUser<'a>

§

impl<'a> Unpin for UpdateUser<'a>

§

impl<'a> UnsafeUnpin for UpdateUser<'a>

§

impl<'a> UnwindSafe for UpdateUser<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<E, T, C> AsyncQuery<T, C> for E

Source§

async fn request_async( &self, client: &C, ) -> Result<Builder, APIError<<C as RestClient>::Error>>

Starts building the query request.
Source§

async fn send_async( &self, client: &C, request: Builder, ) -> Result<Response<Bytes>, APIError<<C as RestClient>::Error>>

Sends the request.
Source§

async fn query_async( &self, client: &C, ) -> Result<T, APIError<<C as RestClient>::Error>>

Perform the query asynchronously against the client.
Source§

async fn finalise_async( &self, response: Response<Bytes>, ) -> Result<T, APIError<<C as RestClient>::Error>>

Finalises the request by returning the response.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<E, T, C> Query<T, C> for E
where E: Endpoint, T: DeserializeOwned, C: Client,

Source§

fn request( &self, client: &C, ) -> Result<Builder, APIError<<C as RestClient>::Error>>

Starts building the query request.
Source§

fn send( &self, client: &C, request: Builder, ) -> Result<Response<Bytes>, APIError<<C as RestClient>::Error>>

Sends the request.
Source§

fn finalise( &self, response: Response<Bytes>, ) -> Result<T, APIError<<C as RestClient>::Error>>

Finalises the request by returning the response.
Source§

fn query(&self, client: &C) -> Result<T, APIError<<C as RestClient>::Error>>

Perform the query against the client.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,