Skip to main content

WellKnownTypes

Enum WellKnownTypes 

Source
pub enum WellKnownTypes {
    Listener,
    HttpConnectionManager,
    RouteConfiguration,
    ScopedRouteConfiguration,
    VirtualHost,
    Cluster,
    ClusterLoadAssignment,
    Secret,
    Runtime,
}
Expand description

Well known types that Any messages may contain while dealing with XDS DiscoveryRequests and DiscoveryResponses.

This type currently suppors the top-level types for xDS services and the HttpConnectionManager type that most applications will need to work with while managing a Listener. It doesn’t include support for extension types or typed configs.

match WellKnownTypes::from_type_url(&any.type_url) {
    Some(WellKnownTypes::Listener) => {
        do_something_with_listener(Listener::decode(&any.value).unwrap())
    }
    _ => todo!(),
}

§pbjson

With the pbjson feature enabled, Any messages use WellKnownTypes for canonical json conversion and any type listed in WellKnownTypes will be serialized as a struct instead of as an opaque blob. For example, an Any containing an HttpConnectionManager would serialize to.

{
    "@type": "type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager",
    "route_config": {
        "name": "test_route"
    }
}

Variants§

§

Listener

An XDS Listener for LDS.

§

HttpConnectionManager

An HttpConnectionManager, included in XDS Listeners.

§

RouteConfiguration

A RouteConfiguration type, used in RDS.

§

ScopedRouteConfiguration

A ScopedRouteConfiguration, used in SRDS.

§

VirtualHost

A VirtualHost, used in VHDS.

§

Cluster

A Cluster, used in CDS

§

ClusterLoadAssignment

A ClusterLoadAssignment, used in EDS.

§

Secret

A Secret, used in SDS.

§

Runtime

A Runtime, used in RTDS.

Implementations§

Source§

impl WellKnownTypes

Source

pub fn all() -> &'static [WellKnownTypes]

Source

pub fn from_type_url(type_url: &str) -> Option<Self>

Source

pub fn type_url(&self) -> &'static str

Trait Implementations§

Source§

impl Clone for WellKnownTypes

Source§

fn clone(&self) -> WellKnownTypes

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 Copy for WellKnownTypes

Source§

impl Debug for WellKnownTypes

Source§

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

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

impl Enum for WellKnownTypes

Source§

const LENGTH: usize

Length of the enum.
Source§

fn from_usize(value: usize) -> Self

Takes an usize, and returns an element matching into_usize function.
Source§

fn into_usize(self) -> usize

Returns an unique identifier for a value within range of 0..Array::LENGTH.
Source§

impl<V> EnumArray<V> for WellKnownTypes

Source§

type Array = [V; 9]

Representation of an enum map for type V.
Source§

impl Eq for WellKnownTypes

Source§

impl PartialEq for WellKnownTypes

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for WellKnownTypes

Auto Trait Implementations§

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more