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, InvalidUri>

This is supported on feature="transport" only.

Convert an Endpoint from shared bytes.

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

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

This is supported on feature="transport" only.

Apply a timeout to each request.

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

pub fn tcp_keepalive(self, tcp_keepalive: Option<Duration>) -> Self

This is supported on feature="transport" only.

Set whether TCP keepalive messages are enabled on accepted connections.

If None is specified, keepalive is disabled, otherwise the duration specified will be the time to remain idle before sending TCP keepalive probes.

Default is no keepalive (None)

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

This is supported on feature="transport" only.

Apply a concurrency limit to each request.

builder.concurrency_limit(256);

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

This is supported on feature="transport" only.

Apply a rate limit to each request.

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

pub fn initial_stream_window_size(self, sz: impl Into<Option<u32>>) -> Self

This is supported on feature="transport" only.

Sets the SETTINGS_INITIAL_WINDOW_SIZE option for HTTP2 stream-level flow control.

Default is 65,535

pub fn initial_connection_window_size(self, sz: impl Into<Option<u32>>) -> Self

This is supported on feature="transport" only.

Sets the max connection-level flow control for HTTP2

Default is 65,535

pub fn tls_config(self, tls_config: ClientTlsConfig) -> Self

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

Configures TLS for the endpoint.

pub fn tcp_nodelay(self, enabled: bool) -> Self

This is supported on feature="transport" only.

Set the value of TCP_NODELAY option for accepted connections. Enabled by default.

pub async fn connect<'_>(&'_ self) -> Result<Channel, Error>

This is supported on feature="transport" only.

Create a channel from this config.

pub async fn connect_with_connector<'_, C>(
    &'_ self,
    connector: C
) -> Result<Channel, Error> where
    C: MakeConnection<Uri> + Send + 'static,
    C::Connection: Unpin + Send + 'static,
    C::Future: Send + 'static,
    Box<dyn Error + Send + Sync>: From<C::Error> + Send + 'static, 

This is supported on feature="transport" only.

Connect with a custom connector.

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 Debug for Endpoint

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

Formats the value using the given formatter.

impl From<Uri> for Endpoint

fn from(uri: Uri) -> Self

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.

impl TryFrom<Bytes> for Endpoint

type Error = InvalidUri

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 = InvalidUri

The type returned in the event of a conversion error.

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

Performs the conversion.