Skip to main content

EndpointPolicy

Enum EndpointPolicy 

Source
pub enum EndpointPolicy<'a> {
    Fixed(EndpointIdentity<'a>),
    OfficialSet(&'a [EndpointIdentity<'a>]),
    RegionDerived(RegionEndpoint<'a>),
    AcknowledgedCustom(AcknowledgedCustomEndpoint<'a>),
}
Expand description

Allocation-free provider-owned endpoint admission policy.

Variants§

§

Fixed(EndpointIdentity<'a>)

One immutable provider endpoint.

§

OfficialSet(&'a [EndpointIdentity<'a>])

A bounded finite set of official provider endpoints.

§

RegionDerived(RegionEndpoint<'a>)

One endpoint derived from a provider region.

§

AcknowledgedCustom(AcknowledgedCustomEndpoint<'a>)

One explicitly acknowledged custom credential destination.

Implementations§

Source§

impl<'a> EndpointPolicy<'a>

Source

pub const fn fixed(identity: EndpointIdentity<'a>) -> Self

Admits one fixed provider-owned endpoint.

Examples found in repository?
examples/prepared_request.rs (line 77)
46    fn prepare<'storage>(
47        &self,
48        storage: PreparationStorage<'storage>,
49    ) -> Result<PreparedRequest<'storage>, Self::Error> {
50        let (target_storage, _body_storage) = storage.into_parts();
51        let target = target_storage
52            .get_mut(..17)
53            .ok_or(PrepareError::TargetBuffer)?;
54        target.copy_from_slice(b"/resources?page=1");
55        let target = core::str::from_utf8(target).map_err(|_| PrepareError::InvalidTarget)?;
56        let target = RequestTarget::new(target).map_err(|_| PrepareError::InvalidTarget)?;
57        let request = TransportRequest::new(Method::Get, target);
58        let metadata = OperationMetadata::new(
59            OperationImpact::ReadOnly,
60            RequestSemantics::Safe,
61            RetryEligibility::ExplicitPolicy,
62            CostIntent::NoKnownCost,
63        )
64        .map_err(|_| PrepareError::InvalidMetadata)?;
65        let response_policy = ResponsePolicy::new(
66            &OK_STATUS,
67            ContentTypePolicy::Required(&JSON_MEDIA),
68            ResponseBodyPolicy::Required,
69            65_536,
70        )
71        .map_err(|_| PrepareError::InvalidResponsePolicy)?;
72        let endpoint =
73            EndpointIdentity::new(EndpointScheme::Https, "api.example.invalid", 443, "/v1")
74                .map_err(|_| PrepareError::InvalidEndpoint)?;
75        Ok(PreparedRequest::new(
76            request,
77            ProviderService::from_marker::<ComputeService>(EndpointPolicy::fixed(endpoint)),
78            metadata,
79            response_policy,
80        ))
81    }
Source

pub fn official_set( identities: &'a [EndpointIdentity<'a>], ) -> Result<Self, EndpointPolicyError>

Admits one of a bounded finite provider-owned endpoint set.

Source

pub const fn region_derived(endpoint: RegionEndpoint<'a>) -> Self

Admits one provider-derived regional endpoint.

Source

pub const fn acknowledged_custom( endpoint: AcknowledgedCustomEndpoint<'a>, ) -> Self

Admits one explicitly acknowledged custom credential destination.

Source

pub const fn kind(self) -> EndpointPolicyKind

Returns the policy’s trust provenance.

Source

pub fn admits(self, candidate: EndpointIdentity<'_>) -> bool

Reports whether the exact destination is admitted.

Source

pub fn verify( self, candidate: EndpointIdentity<'_>, ) -> Result<(), EndpointPolicyError>

Fails closed unless the exact destination is admitted.

Trait Implementations§

Source§

impl<'a> Clone for EndpointPolicy<'a>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for EndpointPolicy<'a>

Source§

impl<'a> Debug for EndpointPolicy<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for EndpointPolicy<'a>

Source§

impl<'a> PartialEq for EndpointPolicy<'a>

Source§

fn eq(&self, other: &EndpointPolicy<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for EndpointPolicy<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for EndpointPolicy<'a>

§

impl<'a> RefUnwindSafe for EndpointPolicy<'a>

§

impl<'a> Send for EndpointPolicy<'a>

§

impl<'a> Sync for EndpointPolicy<'a>

§

impl<'a> Unpin for EndpointPolicy<'a>

§

impl<'a> UnsafeUnpin for EndpointPolicy<'a>

§

impl<'a> UnwindSafe for EndpointPolicy<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.