Skip to main content

User

hf_hub::users

Struct User 

Source 
pub struct User {
Show 21 fields
    pub username: String,
    pub fullname: Option<String>,
    pub avatar_url: Option<String>,
    pub user_type: Option<String>,
    pub details: Option<String>,
    pub is_following: Option<bool>,
    pub is_pro: Option<bool>,
    pub num_models: Option<u64>,
    pub num_datasets: Option<u64>,
    pub num_spaces: Option<u64>,
    pub num_discussions: Option<u64>,
    pub num_papers: Option<u64>,
    pub num_upvotes: Option<u64>,
    pub num_likes: Option<u64>,
    pub num_following: Option<u64>,
    pub num_followers: Option<u64>,
    pub email: Option<String>,
    pub email_verified: Option<bool>,
    pub plan: Option<String>,
    pub can_pay: Option<bool>,
    pub orgs: Option<Vec<OrgMembership>>,

}
Expand description

A Hugging Face Hub user account.

Returned by HFClient::whoami and the various user-lookup endpoints. Only username is guaranteed to be set; the remaining fields are populated for the authenticated caller’s own whoami response or when the field is publicly visible on the target user’s profile.

Fields§

§username: String

Hub handle (slug) of the user — the name used in URLs such as https://huggingface.co/<username>.

§fullname: Option<String>

Display name as shown on the user’s profile, when set.

§avatar_url: Option<String>

URL to the user’s avatar image.

§user_type: Option<String>

Account type, typically "user" or "org".

§details: Option<String>

Free-text bio shown on the user’s profile.

§is_following: Option<bool>

Whether the authenticated caller follows this user.

§is_pro: Option<bool>

Whether the user is on a Pro plan.

§num_models: Option<u64>

Number of models created by the user.

§num_datasets: Option<u64>

Number of datasets created by the user.

§num_spaces: Option<u64>

Number of Spaces created by the user.

§num_discussions: Option<u64>

Number of discussions initiated by the user.

§num_papers: Option<u64>

Number of papers authored by the user.

§num_upvotes: Option<u64>

Upvotes the user has received.

§num_likes: Option<u64>

Likes the user has given.

§num_following: Option<u64>

Number of users this user is following.

§num_followers: Option<u64>

Number of users following this user.

§email: Option<String>

Email address — only returned by whoami for the authenticated user.

§email_verified: Option<bool>

Whether the email has been verified — only returned by whoami.

§plan: Option<String>

Billing plan identifier — only returned by whoami.

§can_pay: Option<bool>

Whether the account has a valid payment method — only returned by whoami.

§orgs: Option<Vec<OrgMembership>>

Organizations the authenticated user belongs to. Only populated by whoami for the caller themselves.

Trait Implementations§

Source§

impl Clone for User

Source§

fn clone(&self) -> User

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
Source§

impl Debug for User

Source§

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

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

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

§

impl Freeze for User

§

impl RefUnwindSafe for User

§

impl Send for User

§

impl Sync for User

§

impl Unpin for User

§

impl UnsafeUnpin for User

§

impl UnwindSafe for User

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<E> ResultError for E
where E: Send + Debug + Sync,

Source§

impl<T> ResultType for T
where T: Send + Clone + Sync + Debug,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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