talksik/tonic
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: Point to Request::set_timeout in Endpoint::timeout docs (#817)

Browse Source
This commit is contained in:
Thomas de Zeeuw
2021-10-28 10:24:07 -04:00
committed by GitHub
parent a6c77d1f77
commit 7ea854b695
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tonic/src/transport/channel/endpoint.rs
+8
View File
@@ -113,6 +113,14 @@ impl Endpoint {
/// # let mut builder = Endpoint::from_static("https://example.com"); /// # let mut builder = Endpoint::from_static("https://example.com");
/// builder.timeout(Duration::from_secs(5)); /// builder.timeout(Duration::from_secs(5));
/// ``` /// ```
///
/// # Notes
///
/// This does **not** set the timeout metadata (`grpc-timeout` header) on
/// the request, meaning the server will not be informed of this timeout,
/// for that use [`Request::set_timeout`].
///
/// [`Request::set_timeout`]: crate::Request::set_timeout
pub fn timeout(self, dur: Duration) -> Self { pub fn timeout(self, dur: Duration) -> Self {
Endpoint { Endpoint {
timeout: Some(dur), timeout: Some(dur),