Enum AltSvc 

pub enum AltSvc {
    Clear,
    Alternatives(NonEmptyVec<AlternativeService>),
}

Available on crate features http and std only.

The Alt-Svc response header defined by RFC 7838 section 3.

Alternative services are ordered by server preference. Self::Clear asks a client to invalidate every cached alternative for the origin. Unknown parameters are ignored during decoding and are not re-encoded.

Security

This header is an untrusted routing hint, not authorization. Consumers must retain the origin URI authority and HTTP Host header; use the origin host for SNI, certificate, and pin validation; reject weaker protocols; and preserve proxy policy. See RFC 7838 sections 2.1 through 2.4 and 9.

Example

use rama_http_headers::{AltSvc, AlternativeService, HeaderMapExt};
use rama_http_types::HeaderMap;
use rama_net::tls::ApplicationProtocol;

let service = AlternativeService::new(ApplicationProtocol::HTTP_3, 443)
    .unwrap()
    .with_max_age_seconds(3_600)
    .with_persist(true);
let mut headers = HeaderMap::new();
headers.typed_insert(AltSvc::new(service));

assert_eq!(
    headers["alt-svc"],
    r#"h3=":443"; ma=3600; persist=1"#,
);

Variants

Clear

Invalidate every cached alternative service for the origin.

Alternatives(NonEmptyVec<AlternativeService>)

Ordered alternative services, most preferred first.

Implementations

impl AltSvc

pub fn new(service: AlternativeService) -> AltSvc

Create a header advertising one alternative service.

pub const fn is_clear(&self) -> bool

Return whether this header clears cached alternatives.

pub fn alternatives(&self) -> Option<impl ExactSizeIterator>

Return the advertised services, or None for Self::Clear.

Trait Implementations

impl Clone for AltSvc

fn clone(&self) -> AltSvc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AltSvc

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

Formats the value using the given formatter.

impl Eq for AltSvc

impl From<AlternativeService> for AltSvc

fn from(service: AlternativeService) -> AltSvc

Converts to this type from the input type.

impl HeaderDecode for AltSvc

fn decode<'i, I>(values: &mut I) -> Result<AltSvc, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for AltSvc

fn encode<E>(&self, values: &mut E)

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl PartialEq for AltSvc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AltSvc

impl TypedHeader for AltSvc

fn name() -> &'static HeaderName

The name of this header.