Struct scratchstack_aws_principal::User

pub struct User { /* private fields */ }

Details about an AWS IAM user.

User structs are immutable.

Implementations

impl User

pub fn new(
    partition: &str,
    account_id: &str,
    path: &str,
    user_name: &str
) -> Result<Self, PrincipalError>

Create a User object.

Arguments

• account_id: The 12 digit account id. This must be composed of 12 ASCII digits or a PrincipalError::InvalidAccountId error will be returned.
• path: The IAM path the group is under. This must meet the following requirements or a PrincipalError::InvalidPath error will be returned:
  • The path must contain between 1 and 512 characters.
  • The path must start and end with /.
  • All characters in the path must be in the ASCII range 0x21 (!) through 0x7E (~). The AWS documentation erroneously indicates that 0x7F (DEL) is acceptable; however, the IAM APIs reject this character.
• user_name: The name of the user. This must meet the following requirements or a PrincipalError::InvalidUserName error will be returned:
  • The name must contain between 1 and 64 characters.
  • The name must be composed to ASCII alphanumeric characters or one of , - . = @ _.

Return value

If all of the requirements are met, a User object is returned. Otherwise, a PrincipalError error is returned.

pub fn partition(&self) -> &str

The partition of the user.

pub fn account_id(&self) -> &str

The account ID of the user.

pub fn path(&self) -> &str

The path of the user.

pub fn user_name(&self) -> &str

The name of the user.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl Display for User

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

Formats the value using the given formatter.

impl From<&User> for Arn

fn from(user: &User) -> Arn

Converts to this type from the input type.

impl From<User> for Principal

fn from(user: User) -> Self

Converts to this type from the input type.

impl From<User> for PrincipalIdentity

Wrap a User in a PrincipalIdentity.

fn from(user: User) -> Self

Converts to this type from the input type.

impl FromStr for User

fn from_str(arn: &str) -> Result<Self, PrincipalError>

Parse an ARN, returning a User if the ARN is a valid user ARN.

Example

let result = User::from_str("arn:aws:iam::123456789012:user/username");
assert!(result.is_ok());

type Err = PrincipalError

The associated error which can be returned from parsing.

impl Hash for User

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for User

fn cmp(&self, other: &User) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

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 ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<User> for User

fn partial_cmp(&self, other: &User) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&Arn> for User

fn try_from(arn: &Arn) -> Result<Self, Self::Error>

If an Arn represents a valid IAM user, convert it to a User; otherwise, return a PrincipalError indicating what is wrong with the ARN.

Example

let arn = Arn::from_str("arn:aws:iam::123456789012:user/path/user-name").unwrap();
let user = User::try_from(&arn).unwrap();
assert_eq!(user.path(), "/path/");
assert_eq!(user.user_name(), "user-name");

type Error = PrincipalError

The type returned in the event of a conversion error.

impl Eq for User

impl StructuralEq for User

impl StructuralPartialEq for User