Skip to main content

User

Struct User 

Source
pub struct User { /* private fields */ }
Expand description

Represents an authenticated user with roles and authorities.

§Spring Equivalent

UserDetails / User

§Example

use actix_security_core::http::security::User;

let user = User::new("admin".into(), "password".into())
    .roles(&["ADMIN".into(), "USER".into()])
    .authorities(&["users:read".into(), "users:write".into()]);

assert!(user.has_role("ADMIN"));
assert!(user.has_authority("users:read"));

Implementations§

Source§

impl User

Source

pub fn new(username: String, password: String) -> Self

Creates a new user with username and plain-text password.

§Note

For production use, prefer with_encoded_password with a proper password encoder like Argon2.

Source

pub fn with_encoded_password(username: &str, encoded_password: String) -> Self

Creates a new user with username and pre-encoded password.

§Spring Security Equivalent

User.withUsername().password("{bcrypt}$2a$...").build()

§Example
use actix_security_core::http::security::{User, Argon2PasswordEncoder, PasswordEncoder};

let encoder = Argon2PasswordEncoder::new();
let encoded = encoder.encode("secret");

let user = User::with_encoded_password("admin", encoded)
    .roles(&["ADMIN".into()]);
Source

pub fn get_username(&self) -> &str

Returns the username.

Source

pub fn get_password(&self) -> &str

Returns the password (for authentication checks).

Source

pub fn get_roles(&self) -> &[String]

Returns the user’s roles.

Source

pub fn get_authorities(&self) -> &[String]

Returns the user’s authorities.

Source

pub fn roles(self, roles: &[String]) -> Self

Adds roles to the user (builder pattern).

Source

pub fn authorities(self, authorities: &[String]) -> Self

Adds authorities to the user (builder pattern).

Source

pub fn has_role(&self, role: &str) -> bool

Checks if the user has a specific role.

Source

pub fn has_any_role(&self, roles: &[&str]) -> bool

Checks if the user has ANY of the specified roles (OR logic).

Source

pub fn has_all_roles(&self, roles: &[&str]) -> bool

Checks if the user has ALL of the specified roles (AND logic).

Source

pub fn has_authority(&self, authority: &str) -> bool

Checks if the user has a specific authority.

Source

pub fn has_any_authority(&self, authorities: &[&str]) -> bool

Checks if the user has ANY of the specified authorities (OR logic).

Source

pub fn has_all_authorities(&self, authorities: &[&str]) -> bool

Checks if the user has ALL of the specified authorities (AND logic).

Source

pub fn has_roles(&self, roles: &[String]) -> bool

Checks if the user has ANY of the specified roles (legacy).

Trait Implementations§

Source§

impl Clone for User

Source§

fn clone(&self) -> User

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

Source§

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

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

impl Display for User

Source§

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

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

impl From<&User> for SessionUser

Source§

fn from(user: &User) -> Self

Converts to this type from the input type.
Source§

impl From<SessionUser> for User

Source§

fn from(session_user: SessionUser) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for User

§

impl RefUnwindSafe for User

§

impl Send for User

§

impl Sync for User

§

impl Unpin 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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: 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: 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<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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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