Struct tonic::transport::Endpoint

pub struct Endpoint { /* fields omitted */ }

This is supported on feature="transport" only.

Channel builder.

This struct is used to build and configure HTTP/2 channels.

Methods

impl Endpoint

pub fn from_static(s: &'static str) -> Self

This is supported on feature="transport" only.

Convert an Endpoint from a static string.

Endpoint::from_static("https://example.com");

pub fn from_shared(s: impl Into<Bytes>) -> Result<Self, InvalidUriBytes>

This is supported on feature="transport" only.

Convert an Endpoint from shared bytes.

Endpoint::from_shared("https://example.com".to_string());

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn timeout(&mut self, dur: Duration) -> &mut Self

This is supported on feature="transport" only.

Apply a timeout to each request.

builder.timeout(Duration::from_secs(5));

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn concurrency_limit(&mut self, limit: usize) -> &mut Self

This is supported on feature="transport" only.

Apply a concurrency limit to each request.

builder.concurrency_limit(256);

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn rate_limit(&mut self, limit: u64, duration: Duration) -> &mut Self

This is supported on feature="transport" only.

Apply a rate limit to each request.

builder.rate_limit(32, Duration::from_secs(1));

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn openssl_tls(
    &mut self,
    ca: Certificate,
    domain: impl Into<Option<String>>
) -> &mut Self

This is supported on feature="transport" and feature="openssl" only.

Enable TLS and apply the CA as the root certificate.

Providing an optional domain to override. If None is passed to this the TLS implementation will use the Uri that was used to create the Endpoint builder.

let ca = std::fs::read_to_string("ca.pem")?;

let ca = Certificate::from_pem(ca);

builder.openssl_tls(ca, "example.com".to_string());

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn rustls_tls(
    &mut self,
    ca: Certificate,
    domain: impl Into<Option<String>>
) -> &mut Self

This is supported on feature="transport" and feature="rustls" only.

Enable TLS and apply the CA as the root certificate.

Providing an optional domain to override. If None is passed to this the TLS implementation will use the Uri that was used to create the Endpoint builder.

let ca = std::fs::read_to_string("ca.pem")?;

let ca = Certificate::from_pem(ca);

builder.rustls_tls(ca, "example.com".to_string());

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn intercept_headers<F>(&mut self, f: F) -> &mut Self where
    F: Fn(&mut HeaderMap) + Send + Sync + 'static, 

This is supported on feature="transport" only.

Intercept outbound HTTP Request headers;

pub fn channel(&self) -> Channel

This is supported on feature="transport" only.

Create a channel from this config.

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Uri> for Endpoint

fn from(uri: Uri) -> Self

Performs the conversion.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl TryFrom<Bytes> for Endpoint

type Error = InvalidUriBytes

The type returned in the event of a conversion error.

fn try_from(t: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Endpoint

type Error = InvalidUriBytes

The type returned in the event of a conversion error.

fn try_from(t: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'static str> for Endpoint

type Error = Never

The type returned in the event of a conversion error.

fn try_from(t: &'static str) -> Result<Self, Self::Error>

Performs the conversion.