Struct Endpoint

pub struct Endpoint { /* private fields */ }

👎Deprecated: Use .endpoint_url(...) directly instead

API Endpoint

This implements an API endpoint as specified in the Smithy Endpoint Specification

Implementations

impl Endpoint

pub fn mutable_uri(uri: Uri) -> Result<Endpoint, InvalidEndpointError>

Create a new endpoint from a URI

Certain services will augment the endpoint with additional metadata. For example, S3 can prefix the host with the bucket name. If your endpoint does not support this, (for example, when communicating with localhost), use Endpoint::immutable.

pub fn mutable(uri: impl AsRef<str>) -> Result<Endpoint, InvalidEndpointError>

Create a new endpoint from a URI string

Certain services will augment the endpoint with additional metadata. For example, S3 can prefix the host with the bucket name. If your endpoint does not support this, (for example, when communicating with localhost), use Endpoint::immutable.

pub fn uri(&self) -> &Uri

Returns the URI of this endpoint

pub fn immutable_uri(uri: Uri) -> Result<Endpoint, InvalidEndpointError>

Create a new immutable endpoint from a URI

use http::Uri;
let uri = Uri::from_static("http://localhost:8000");
let endpoint = Endpoint::immutable_uri(uri);

Certain services will augment the endpoint with additional metadata. For example, S3 can prefix the host with the bucket name. This constructor creates an endpoint which will ignore those mutations. If you want an endpoint which will obey mutation requests, use Endpoint::mutable instead.

pub fn immutable(uri: impl AsRef<str>) -> Result<Endpoint, InvalidEndpointError>

Create a new immutable endpoint from a URI string

let endpoint = Endpoint::immutable("http://localhost:8000");

Certain services will augment the endpoint with additional metadata. For example, S3 can prefix the host with the bucket name. This constructor creates an endpoint which will ignore those mutations. If you want an endpoint which will obey mutation requests, use Endpoint::mutable instead.

pub fn set_endpoint( &self, uri: &mut Uri, prefix: Option<&EndpointPrefix>, ) -> Result<(), InvalidEndpointError>

Sets the endpoint on uri, potentially applying the specified prefix in the process.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl ResolveAwsEndpoint for Endpoint

An Endpoint can be its own resolver to support static endpoints

fn resolve_endpoint( &self, _region: &Region, ) -> Result<AwsEndpoint, Box<dyn Error + Send + Sync>>

Resolves the AWS endpoint for a given region.

impl<T> ResolveEndpoint<T> for Endpoint

This allows customers that use Endpoint to override the endpoint to continue to do so

fn resolve_endpoint( &self, _params: &T, ) -> Result<Endpoint, ResolveEndpointError>

impl ResolveStediEndpoint for Endpoint

An Endpoint can be its own resolver to support static endpoints

fn resolve_endpoint( &self, _region: &Region, ) -> Result<StediEndpoint, Box<dyn Error + Send + Sync>>

Resolves the Stedi endpoint for a given region.