Struct EndpointTemplate 

pub struct EndpointTemplate { /* private fields */ }

Template for creating Endpoints.

This structure is used to store all the information necessary to create an Endpoint. It then creates an Endpoint to a specific IP address using the build method.

Implementations

impl EndpointTemplate

pub fn new(url: impl TryInto<Url>) -> Result<Self, EndpointTemplateError>

Creates a new EndpointTemplate from the provided URL.

Errors

• Will return EndpointTemplateError::NotAUrl if the provided URL is not a valid URL.
• Will return EndpointTemplateError::HostMissing if the provided URL does not contain a host.
• Will return EndpointTemplateError::AlreadyIpAddress if the provided URL already contains an IP address.
• Will return EndpointTemplateError::Inconvertible if the provided URL cannot be converted to the tonic’s internal representation.

pub fn build(&self, ip_address: impl Into<IpAddr>) -> Endpoint

Builds an Endpoint to the IP address.

This will substitute the hostname in the URL with the provided IP address, create a new Endpoint from it, and apply all the settings set in the builder.

pub fn domain(&self) -> &str

Returns the hostname of the URL held in the template.

pub fn user_agent( self, user_agent: impl TryInto<HeaderValue>, ) -> Result<Self, EndpointTemplateError>

r.f. Endpoint::user_agent.

Errors

Will return EndpointTemplateError::InvalidUserAgent if the provided value cannot be converted to a HeaderValue and would cause a failure when building an endpoint.

pub fn origin(self, origin: Uri) -> Self

r.f. Endpoint::origin.

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

r.f. Endpoint::timeout.

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

r.f. Endpoint::connect_timeout.

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

r.f. Endpoint::tcp_keepalive.

pub fn tcp_keepalive_interval(self, interval: Duration) -> Self

r.f. Endpoint::tcp_keepalive_interval.

pub fn tcp_keepalive_retries(self, retries: u32) -> Self

r.f. Endpoint::tcp_keepalive_retries.

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

r.f. Endpoint::concurrency_limit

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

r.f. Endpoint::rate_limit.

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

r.f. Endpoint::initial_stream_window_size.

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

r.f. Endpoint::initial_connection_window_size.

pub fn buffer_size(self, sz: impl Into<Option<usize>>) -> Self

r.f. Endpoint::buffer_size.

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

Available on crate feature tls only.

r.f. Endpoint::tls_config.

Errors

Will return EndpointTemplateError::InvalidTlsConfig if the provided config cannot be passed to an Endpoint and would cause a failure when building an endpoint.

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

r.f. Endpoint::tcp_nodelay.

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

r.f. Endpoint::http2_keep_alive_interval.

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

r.f. Endpoint::keep_alive_timeout.

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

r.f. Endpoint::keep_alive_while_idle.

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

r.f. Endpoint::http2_adaptive_window.

pub fn http2_max_header_list_size(self, size: u32) -> Self

r.f. Endpoint::http2_max_header_list_size.

pub fn local_address(self, ip: Option<IpAddr>) -> Self

r.f. Endpoint::local_address.

Trait Implementations

impl Clone for EndpointTemplate

fn clone(&self) -> EndpointTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointTemplate

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

Formats the value using the given formatter.

impl TryFrom<Url> for EndpointTemplate

type Error = EndpointTemplateError

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self, Self::Error>

Performs the conversion.