Struct OperationMetadata 

pub struct OperationMetadata { /* private fields */ }

Complete operation safety metadata without permissive defaults.

use cloud_sdk::operation::OperationMetadata;

let _: OperationMetadata = Default::default();

Implementations

impl OperationMetadata

pub const fn new( impact: OperationImpact, semantics: RequestSemantics, retry: RetryEligibility, cost: CostIntent, ) -> Result<Self, OperationMetadataError>

Creates complete metadata after checking safety invariants.

Examples found in repository

examples/prepared_request.rs (lines 43-48)

    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,
        )
        .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)?;
        Ok(PreparedRequest::new(
            request,
            ProviderService::new(Provider::Hetzner, ApiFamily::Cloud, endpoint),
            metadata,
            response_policy,
        ))
    }

pub const fn impact(self) -> OperationImpact

Returns provider-state impact.

Examples found in repository

examples/prepared_request.rs (line 76)

fn main() {
    let mut target = [0_u8; MAX_REQUEST_TARGET_BYTES];
    let mut body = [0_u8; 1];
    let prepared = ListResources.prepare(PreparationStorage::new(&mut target, &mut body));
    let Ok(prepared) = prepared else { return };

    assert_eq!(prepared.transport_request().method(), Method::Get);
    assert_eq!(prepared.metadata().impact(), OperationImpact::ReadOnly);
    assert_eq!(prepared.response_policy().max_body_bytes(), 65_536);
}

pub const fn semantics(self) -> RequestSemantics

Returns HTTP request semantics.

pub const fn retry_eligibility(self) -> RetryEligibility

Returns explicit retry eligibility.

pub const fn cost_intent(self) -> CostIntent

Returns direct cost intent.

Trait Implementations

impl Clone for OperationMetadata

fn clone(&self) -> OperationMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OperationMetadata

impl Debug for OperationMetadata

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

Formats the value using the given formatter.

impl Eq for OperationMetadata

impl Hash for OperationMetadata

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 OperationMetadata

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OperationMetadata

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