Skip to main content

UserClient

nextcloud_users

Struct UserClient

pub struct UserClient<'a, T: Transport, A: AuthProvider> { /* private fields */ }

Expand description

Client for Nextcloud user provisioning and server capabilities.

Wraps an OcsClient by reference and provides high-level typed calls for:

Server capabilities discovery (/ocs/v1.php/cloud/capabilities or /ocs/v2.php/cloud/capabilities)
Current authenticated user metadata (/ocs/v1.php/cloud/user or /ocs/v2.php/cloud/user)
User profile lookup by user ID (/ocs/v1.php/cloud/users/{userid} or /ocs/v2.php/cloud/users/{userid})

Official documentation:

Nextcloud OCS Overview: https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html
User Metadata: https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata
Capabilities API: https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#capabilities-api
User Provisioning API: https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_provisioning_api.html

Implementations§

impl<'a, T: Transport, A: AuthProvider> UserClient<'a, T, A>

pub const fn new(ocs: &'a OcsClient<T, A>) -> Self

Binds a user client to an underlying OcsClient.

pub const fn ocs(&self) -> &'a OcsClient<T, A>

Borrows the underlying OcsClient.

pub async fn capabilities(&self) -> Result<Capabilities, Error>

Fetches server capabilities.

Sends a GET request to /ocs/v2.php/cloud/capabilities?format=json (the v2 equivalent of /ocs/v1.php/cloud/capabilities).

See https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#capabilities-api.

pub async fn current_user(&self) -> Result<User, Error>

Fetches the profile and storage quota of the currently authenticated user.

Sends a GET request to /ocs/v2.php/cloud/user?format=json (the v2 equivalent of /ocs/v1.php/cloud/user).

See https://docs.nextcloud.com/server/latest/developer_manual/client_apis/LoginFlow/index.html.

pub async fn get_user(&self, user_id: &str) -> Result<User, Error>

Fetches the profile and storage quota of a user by their user identifier.

Sends a GET request to /ocs/v2.php/cloud/users/{userid}?format=json (the v2 equivalent of /ocs/v1.php/cloud/users/{userid}).

See https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html#user-metadata.

Trait Implementations§

impl<'a, T: Clone + Transport, A: Clone + AuthProvider> Clone for UserClient<'a, T, A>

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<'a, T: Copy + Transport, A: Copy + AuthProvider> Copy for UserClient<'a, T, A>

impl<'a, T: Debug + Transport, A: Debug + AuthProvider> Debug for UserClient<'a, T, A>

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

Formats the value using the given formatter. Read more

impl<T: Transport, A: AuthProvider> Display for UserClient<'_, T, A>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<'a, T, A> Freeze for UserClient<'a, T, A>
where &'a OcsClient<T, A>: Freeze,

impl<'a, T, A> RefUnwindSafe for UserClient<'a, T, A>
where &'a OcsClient<T, A>: RefUnwindSafe,

impl<'a, T, A> Send for UserClient<'a, T, A>
where &'a OcsClient<T, A>: Send,

impl<'a, T, A> Sync for UserClient<'a, T, A>
where &'a OcsClient<T, A>: Sync,

impl<'a, T, A> Unpin for UserClient<'a, T, A>
where &'a OcsClient<T, A>: Unpin,

impl<'a, T, A> UnsafeUnpin for UserClient<'a, T, A>
where &'a OcsClient<T, A>: UnsafeUnpin,

impl<'a, T, A> UnwindSafe for UserClient<'a, T, A>
where &'a OcsClient<T, A>: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more