Struct HttpEndpoint 

pub struct HttpEndpoint(/* private fields */);

A Uri proven to be an absolute http/https URL.

Constructing an HttpEndpoint is the only way to obtain one: both HttpEndpoint::new and HttpEndpoint::parse reject URIs without an http/https scheme or without an authority. Sinks that issue requests through HttpClient need this invariant, since HttpClient rejects such URIs at request time, deferring a pure configuration error to runtime.

As a configuration type it deserializes from a string, so an invalid endpoint is rejected at config load time with the config path in the error.

Path composition goes through HttpEndpoint::append_path, which manipates Uri parts directly instead of string-concatenating and re-parsing, so the scheme and authority are preserved and the result is still an absolute http(s) URL.

Implementations

impl HttpEndpoint

pub fn new(uri: Uri) -> Result<Self, HttpEndpointError>

Requires uri to be an absolute http/https URL with a host and a usable port.

The authority check alone is not enough: http://:8080 parses as a valid http::Uri with an authority but an empty host, and http://localhost:notaport parses with a nonempty host but a port that cannot be dialed. Both are checked explicitly.

pub fn parse(endpoint: &str) -> Result<Self, HttpEndpointError>

Parses endpoint and requires it to be an absolute http/https URL.

A missing scheme is defaulted to https, so example.com:8080 becomes https://example.com:8080. An explicit http/https scheme is preserved. Endpoints that still lack a host after defaulting (for example /path) are rejected.

pub const fn as_uri(&self) -> &Uri

Returns the underlying Uri.

pub fn into_uri(self) -> Uri

Consumes the endpoint, returning the underlying Uri.

pub fn extract_basic_auth(self) -> Result<(Self, Option<Auth>)>

Extracts basic-auth credentials embedded in the authority, returning a credential-free endpoint alongside the credentials.

pub fn protocol(&self) -> &str

Returns the URL scheme (http or https) of this endpoint.

HttpEndpoint::new guarantees the scheme is an absolute http/https scheme, so this is infallible.

pub fn append_path(&self, path: &str) -> Result<Self, HttpEndpointError>

Appends path to this endpoint, preserving the scheme and authority.

path may include a leading slash and a query. The existing query, if any, is dropped (as with UriSerde::append_path), but the scheme and authority are preserved and the result is still an absolute http(s) URL.

pub fn append_raw_suffix(&self, suffix: &str) -> Result<Self, HttpEndpointError>

Appends suffix directly to the path without inserting a separator.

Unlike HttpEndpoint::append_path, this does not add a /. It is for API method suffixes that attach directly to a resource path, such as Google’s :publish convention.

Trait Implementations

impl Clone for HttpEndpoint

fn clone(&self) -> HttpEndpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for HttpEndpoint

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for HttpEndpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpEndpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HttpEndpoint

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

Formats the value using the given formatter.

impl From<HttpEndpoint> for String

fn from(value: HttpEndpoint) -> Self

Converts to this type from the input type.

impl PartialEq for HttpEndpoint

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for HttpEndpoint

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl TryFrom<String> for HttpEndpoint

type Error = HttpEndpointError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for HttpEndpoint

impl StructuralPartialEq for HttpEndpoint