Struct Service

pub struct Service { /* private fields */ }

Details about an AWS or AWS-like service.

Service structs are immutable.

Implementations

impl Service

pub fn new( service_name: &str, region: Option<String>, dns_suffix: &str, ) -> Result<Self, PrincipalError>

Create a Service object representing an AWS(-ish) service.

Arguments

• service_name: The name of the service. This must meet the following requirements or a PrincipalError::InvalidService error will be returned:
  • The name must contain between 1 and 32 characters.
  • The name must be composed to ASCII alphanumeric characters or one of , - . = @ _.
• region: The region the service is running in. If None, the service is global.
• dns_suffix: The DNS suffix of the service. This is usually amazonaws.com.

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

Example

let service = Service::new("s3", Some("us-east-1".to_string()), "amazonaws.com").unwrap();
assert_eq!(service.service_name(), "s3");
assert_eq!(service.region(), Some("us-east-1"));
assert_eq!(service.dns_suffix(), "amazonaws.com");
assert_eq!(service.regional_dns_name(), "s3.us-east-1.amazonaws.com");
assert_eq!(service.global_dns_name(), "s3.amazonaws.com");

pub fn service_name(&self) -> &str

The name of the service.

pub fn region(&self) -> Option<&str>

The region of the service. If the service is global, this will be None.

pub fn dns_suffix(&self) -> &str

The DNS suffix of the service.

pub fn regional_dns_name(&self) -> String

The regional DNS name of the service. If the service is global, this will be the same as the global DNS name.

pub fn global_dns_name(&self) -> String

The global DNS name of the service (omitting the regional component, if any).

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Service

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

Formats the value using the given formatter.

impl Display for Service

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

Formats the value using the given formatter.

impl From<Service> for Principal

fn from(service: Service) -> Self

Converts to this type from the input type.

impl From<Service> for PrincipalIdentity

Wrap a Service in a PrincipalIdentity.

fn from(service: Service) -> Self

Converts to this type from the input type.

impl Hash for Service

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 Service

fn cmp(&self, other: &Service) -> 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 Service

fn eq(&self, other: &Service) -> 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 Service

fn partial_cmp(&self, other: &Service) -> 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 Service

impl StructuralPartialEq for Service