Struct tonic::transport::Endpoint

[+] Show declaration

pub struct Endpoint { /* fields omitted */ }

[−] Expand description

Channel builder.

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

Implementations

impl Endpoint[−]

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

Convert an Endpoint from a static string.

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

pub fn from_shared(s: impl Into<Bytes>) -> Result<Self, InvalidUri>[−]

Convert an Endpoint from shared bytes.

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

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

Apply a timeout to each request.

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

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

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[−]

Apply a concurrency limit to each request.

builder.concurrency_limit(256);

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

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[−]

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[−]

Sets the max connection-level flow control for HTTP2

Default is 65,535

pub fn tls_config(self, tls_config: ClientTlsConfig) -> Result<Self, Error>[−]

Configures TLS for the endpoint.

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

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

pub fn http2_keep_alive_interval(self, interval: Duration) -> Self[−]

Set http2 KEEP_ALIVE_INTERVAL. Uses hyper’s default otherwise.

pub fn keep_alive_timeout(self, duration: Duration) -> Self[−]

Set http2 KEEP_ALIVE_TIMEOUT. Uses hyper’s default otherwise.

pub fn keep_alive_while_idle(self, enabled: bool) -> Self[−]

Set http2 KEEP_ALIVE_WHILE_IDLE. Uses hyper’s default otherwise.

pub async fn connect(&self) -> Result<Channel, Error>[−]

Create a channel from this config.

pub fn connect_lazy(&self) -> Result<Channel, Error>[−]

Create a channel from this config.

The channel returned by this method does not attempt to connect to the endpoint until first use.

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, [−]

Connect with a custom connector.

pub fn uri(&self) -> &Uri[−]

Get the endpoint uri.

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

assert_eq!(endpoint.uri(), &Uri::from_static("https://example.com"));

Trait Implementations

impl Clone for Endpoint[+]

[+] Show hidden undocumented items

fn clone(&self) -> Endpoint[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Endpoint[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl From<Uri> for Endpoint[+]

[+] Show hidden undocumented items

fn from(uri: Uri) -> Self[−]

Performs the conversion.

impl TryFrom<&'static str> for Endpoint[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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.