Struct EndpointIdentity 

pub struct EndpointIdentity<'a> { /* private fields */ }

Borrowed normalized identity of a credential-bound transport endpoint.

DNS input must already be canonical lowercase ASCII. Internationalized names must use their lowercase ASCII A-label form. IPv6 input must be bracketed; comparison uses its parsed 128-bit address, so equivalent text forms have one identity. Zone identifiers are never admitted.

Implementations

impl<'a> EndpointIdentity<'a>

pub fn new( scheme: EndpointScheme, host: &'a str, effective_port: u16, base_path: &'a str, ) -> Result<Self, EndpointIdentityError>

Creates an identity from normalized endpoint components.

Examples found in repository

examples/prepared_request.rs (line 77)

    fn prepare<'storage>(
        &self,
        storage: PreparationStorage<'storage>,
    ) -> Result<PreparedRequest<'storage>, Self::Error> {
        let (target_storage, _body_storage) = storage.into_parts();
        let target = target_storage
            .get_mut(..17)
            .ok_or(PrepareError::TargetBuffer)?;
        target.copy_from_slice(b"/resources?page=1");
        let target = core::str::from_utf8(target).map_err(|_| PrepareError::InvalidTarget)?;
        let target = RequestTarget::new(target).map_err(|_| PrepareError::InvalidTarget)?;
        let request = TransportRequest::new(Method::Get, target);
        let metadata = OperationMetadata::new(
            OperationImpact::ReadOnly,
            RequestSemantics::Safe,
            RetryEligibility::ExplicitPolicy,
            CostIntent::NoKnownCost,
            RequestIdPolicy::Protected,
        )
        .map_err(|_| PrepareError::InvalidMetadata)?;
        let response_policy = ResponsePolicy::new(
            &OK_STATUS,
            ContentTypePolicy::Required(&JSON_MEDIA),
            ResponseBodyPolicy::Required,
            65_536,
        )
        .map_err(|_| PrepareError::InvalidResponsePolicy)?;
        let endpoint =
            EndpointIdentity::new(EndpointScheme::Https, "api.example.invalid", 443, "/v1")
                .map_err(|_| PrepareError::InvalidEndpoint)?;
        let authentication_policy = AuthenticationScopePolicy::new(
            ScopeRequirement::Required(ExampleProvider::ID),
            ScopeRequirement::Required(ComputeService::ID),
            ScopeRequirement::Required(endpoint),
            ScopeRequirement::Forbidden,
            ScopeRequirement::Forbidden,
            ScopeRequirement::Forbidden,
        );
        let content_type =
            HeaderName::new("content-type").map_err(|_| PrepareError::InvalidRawResponsePolicy)?;
        let request_id =
            HeaderName::new("x-request-id").map_err(|_| PrepareError::InvalidRawResponsePolicy)?;
        let raw_response_policy = RawResponsePolicy::new(
            65_536,
            65_536,
            ResponseMediaPolicy::Required(&JSON_MEDIA),
            ResponseMediaPolicy::Required(&JSON_MEDIA),
            &[content_type, request_id],
            8,
        )
        .map_err(|_| PrepareError::InvalidRawResponsePolicy)?;
        PreparedRequest::new(
            request,
            ProviderService::from_marker::<ComputeService>(EndpointPolicy::fixed(endpoint)),
            metadata,
            response_policy,
            authentication_policy,
            raw_response_policy,
        )
        .map_err(|_| PrepareError::InvalidRawResponsePolicy)
    }

pub const fn scheme(self) -> EndpointScheme

Returns the normalized network scheme.

pub const fn host(self) -> &'a str

Returns the admitted host text without credentials or a port.

pub const fn effective_port(self) -> u16

Returns the effective port, including the scheme default when omitted.

pub const fn base_path(self) -> &'a str

Returns the normalized absolute base path.

Trait Implementations

impl<'a> Clone for EndpointIdentity<'a>

fn clone(&self) -> EndpointIdentity<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for EndpointIdentity<'a>

impl Debug for EndpointIdentity<'_>

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

Formats the value using the given formatter.

impl Eq for EndpointIdentity<'_>

impl Hash for EndpointIdentity<'_>

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 EndpointIdentity<'_>

fn cmp(&self, other: &Self) -> 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 EndpointIdentity<'_>

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EndpointIdentity<'_>

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