Struct CanonicalUser

pub struct CanonicalUser { /* private fields */ }

Details about an S3 canonical user.

CanonicalUser structs are immutable.

Implementations

impl CanonicalUser

pub fn new(canonical_user_id: &str) -> Result<Self, PrincipalError>

Create a CanonicalUser object.

Arguments

• canonical_user_id: The canonical user id. This must be a 64 character hex string in lower-case form.

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

Example

let canonical_user = CanonicalUser::new("9da4bcba2132ad952bba3c8ecb37e668d99b310ce313da30c98aba4cdf009a7d").unwrap();
assert_eq!(canonical_user.canonical_user_id(), "9da4bcba2132ad952bba3c8ecb37e668d99b310ce313da30c98aba4cdf009a7d");

pub fn canonical_user_id(&self) -> &str

The canonical user id.

Trait Implementations

impl Clone for CanonicalUser

fn clone(&self) -> CanonicalUser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalUser

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

Formats the value using the given formatter.

impl Display for CanonicalUser

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

Formats the value using the given formatter.

impl From<CanonicalUser> for Principal

fn from(user: CanonicalUser) -> Self

Converts to this type from the input type.

impl From<CanonicalUser> for PrincipalIdentity

Wrap a CanonicalUser in a PrincipalIdentity.

fn from(canonical_user: CanonicalUser) -> Self

Converts to this type from the input type.

impl Hash for CanonicalUser

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CanonicalUser

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CanonicalUser

fn eq(&self, other: &CanonicalUser) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for CanonicalUser

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for CanonicalUser

impl StructuralPartialEq for CanonicalUser