Struct Alpn

pub struct Alpn<Octs: ?Sized>(/* private fields */);

The application layer protocols supported by the service endpoint.

This value lists the protocol names supported by the service endpoint described by the service binding’s target name and, if present, port. The names are the same as used by Application Layer Protocol Negotiation (ALPN) described in [RFC 7301]. Each scheme that uses service bindings defines a set of default protocols that are quietly added to this list unless the NoDefaultAlpn value is present as well. For HTTPS, this default set consists of the "http/1.1" protocol.

The wire format of this value consists of those protocol names each preceeded by a u8 giving their length.

The iter method produces an iterator over the individual protocol names in the value.

Implementations

impl<Octs> Alpn<Octs>

pub unsafe fn from_octets_unchecked(octets: Octs) -> Self

Creates a new value from octets without checking.

Safety

The caller has to ensure that octets contains a properly formated value of at most 65,535 octets.

impl Alpn<[u8]>

pub unsafe fn from_slice_unchecked(slice: &[u8]) -> &Self

Creates a new value for a slice without checking.

Safety

The caller has to ensure that slice contains a properly formated value of at most 65,535 octets.

impl<Octs: ?Sized> Alpn<Octs>

pub fn as_octets(&self) -> &Octs

Returns a reference to the underlying octets sequence.

pub fn as_slice(&self) -> &[u8]

where Octs: AsRef<[u8]>,

Returns a slice of the underlying octets sequence.

impl<Octs: AsRef<[u8]> + ?Sized> Alpn<Octs>

pub fn iter(&self) -> AlpnIter<'_, Octs>

Returns an iterator over the elements of the value.

impl<Octs: AsRef<[u8]>> Alpn<Octs>

pub fn from_octets(octets: Octs) -> Result<Self, ParseError>

Creates an ALPN value from the underlying octets.

The function ensures that octets is a correctly encoded ALPN value. It does not, however, check that the protocol identifiers are valid.

impl Alpn<[u8]>

pub fn from_slice(slice: &[u8]) -> Result<&Self, ParseError>

Creates an ALPN value from an octets slice.

The function ensures that slice is a correctly encoded ALPN value. It does not, however, check that the protocol identifiers are valid.

impl<Octs: AsRef<[u8]>> Alpn<Octs>

pub fn parse<'a, Src: Octets<Range<'a> = Octs> + ?Sized>( parser: &mut Parser<'a, Src>, ) -> Result<Self, ParseError>

Parses an ALPN value from its wire format.

Trait Implementations

impl<Octs: AsRef<[u8]> + ?Sized> AsRef<[u8]> for Alpn<Octs>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<Octs> AsRef<Octs> for Alpn<Octs>

fn as_ref(&self) -> &Octs

Converts this type into a shared reference of the (usually inferred) input type.

impl<Octs: Clone + ?Sized> Clone for Alpn<Octs>

fn clone(&self) -> Alpn<Octs>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Octs: AsRef<[u8]> + ?Sized> ComposeSvcParamValue for Alpn<Octs>

fn compose_len(&self) -> u16

Returns the length of the composed value.

fn compose_value<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

Appends the wire format of the value to the end of target.

impl<Octs: Debug + ?Sized> Debug for Alpn<Octs>

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

Formats the value using the given formatter.

impl<Octs: Octets + ?Sized> Display for Alpn<Octs>

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

Formats the value using the given formatter.

impl<Octs> From<Alpn<Octs>> for AllValues<Octs>

fn from(p: Alpn<Octs>) -> Self

Converts to this type from the input type.

impl<Octs: AsRef<[u8]>> Hash for Alpn<Octs>

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<O, OO> OctetsFrom<Alpn<O>> for Alpn<OO>

where OO: OctetsFrom<O>,

type Error = <OO as OctetsFrom<O>>::Error

fn try_octets_from(source: Alpn<O>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, Octs> ParseSvcParamValue<'a, Octs> for Alpn<Octs::Range<'a>>

where Octs: Octets + ?Sized,

fn parse_value( key: SvcParamKey, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parse a parameter value from wire format.

impl<Octs, OtherOcts> PartialEq<Alpn<OtherOcts>> for Alpn<Octs>

where Octs: AsRef<[u8]>, OtherOcts: AsRef<[u8]>,

fn eq(&self, other: &Alpn<OtherOcts>) -> 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<Octs: ?Sized> SvcParamValue for Alpn<Octs>

fn key(&self) -> SvcParamKey

Returns the parameter key of the value.

impl<Octs: AsRef<[u8]>> Eq for Alpn<Octs>