Skip to content

Commit ac0cde1

Browse files
committed
apply naming convention 'try_' prefix for fallible setters/constructors
most were already up to par with the new standard, but a quick scan revelead some more that still weren't up to this standard. Noticed while updating a fleet of services with the pool methods of the web client easy API not prefixed with `try_` yet
1 parent 560c2e3 commit ac0cde1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+98
-79
lines changed

examples/acme_http_challenge.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ async fn main() {
127127
.build_client()
128128
.boxed();
129129

130-
let client = AcmeClient::new(TEST_DIRECTORY_URL, client)
130+
let client = AcmeClient::try_new(TEST_DIRECTORY_URL, client)
131131
.await
132132
.expect("create acme client");
133133

@@ -154,7 +154,7 @@ async fn main() {
154154
.expect("create account");
155155

156156
let mut order = account
157-
.new_order(NewOrderPayload {
157+
.try_new_order(NewOrderPayload {
158158
identifiers: vec![Identifier::dns("example.com")],
159159
..Default::default()
160160
})

examples/acme_tls_challenge_using_boring.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ async fn main() {
126126
.build_client()
127127
.boxed();
128128

129-
let client = AcmeClient::new(TEST_DIRECTORY_URL, client)
129+
let client = AcmeClient::try_new(TEST_DIRECTORY_URL, client)
130130
.await
131131
.expect("create acme client");
132132

@@ -145,7 +145,7 @@ async fn main() {
145145
.expect("create account");
146146

147147
let mut order = account
148-
.new_order(NewOrderPayload {
148+
.try_new_order(NewOrderPayload {
149149
identifiers: vec![Identifier::dns("example.com")],
150150
..Default::default()
151151
})

examples/acme_tls_challenge_using_rustls.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ async fn main() {
123123
.build_client()
124124
.boxed();
125125

126-
let client = AcmeClient::new(TEST_DIRECTORY_URL, client)
126+
let client = AcmeClient::try_new(TEST_DIRECTORY_URL, client)
127127
.await
128128
.expect("create acme client");
129129

@@ -140,7 +140,7 @@ async fn main() {
140140
.expect("create account");
141141

142142
let mut order = account
143-
.new_order(NewOrderPayload {
143+
.try_new_order(NewOrderPayload {
144144
identifiers: vec![Identifier::dns("example.com")],
145145
..Default::default()
146146
})

examples/http_mitm_proxy_boring.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ async fn main() -> Result<(), BoxError> {
141141
.init();
142142

143143
let mitm_tls_service_data =
144-
new_mitm_tls_service_data().context("generate self-signed mitm tls cert")?;
144+
try_new_mitm_tls_service_data().context("generate self-signed mitm tls cert")?;
145145

146146
let state = State {
147147
mitm_tls_service_data,
@@ -341,7 +341,7 @@ async fn http_mitm_proxy(req: Request) -> Result<Response, Infallible> {
341341
// NOTE: for a production service you ideally use
342342
// an issued TLS cert (if possible via ACME). Or at the very least
343343
// load it in from memory/file, so that your clients can install the certificate for trust.
344-
fn new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
344+
fn try_new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
345345
let tls_server_config = ServerConfig {
346346
application_layer_protocol_negotiation: Some(vec![
347347
ApplicationProtocol::HTTP_2,

examples/http_mitm_proxy_rustls.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ async fn main() -> Result<(), BoxError> {
9090
.init();
9191

9292
let mitm_tls_service_data =
93-
new_mitm_tls_service_data().context("generate self-signed mitm tls cert")?;
93+
try_new_mitm_tls_service_data().context("generate self-signed mitm tls cert")?;
9494

9595
let state = State {
9696
mitm_tls_service_data,
@@ -248,8 +248,8 @@ async fn http_mitm_proxy(req: Request) -> Result<Response, Infallible> {
248248
// NOTE: for a production service you ideally use
249249
// an issued TLS cert (if possible via ACME). Or at the very least
250250
// load it in from memory/file, so that your clients can install the certificate for trust.
251-
fn new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
252-
let data = TlsAcceptorDataBuilder::new_self_signed(SelfSignedData {
251+
fn try_new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
252+
let data = TlsAcceptorDataBuilder::try_new_self_signed(SelfSignedData {
253253
organisation_name: Some("Example Server Acceptor".to_owned()),
254254
..Default::default()
255255
})

examples/http_pooled_client.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ async fn main() {
5858
.with_proxy_support()
5959
.without_tls_support()
6060
.with_default_http_connector()
61-
.with_connection_pool(Default::default())
61+
.try_with_connection_pool(Default::default())
6262
.expect("connection pool")
6363
.build_client();
6464

examples/http_record_har.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ async fn main() -> Result<(), BoxError> {
118118
.init();
119119

120120
let mitm_tls_service_data =
121-
new_mitm_tls_service_data().context("generate self-signed mitm tls cert")?;
121+
try_new_mitm_tls_service_data().context("generate self-signed mitm tls cert")?;
122122

123123
let graceful = rama::graceful::Shutdown::default();
124124

@@ -340,7 +340,7 @@ async fn http_mitm_proxy(req: Request) -> Result<Response, Infallible> {
340340
// NOTE: for a production service you ideally use
341341
// an issued TLS cert (if possible via ACME). Or at the very least
342342
// load it in from memory/file, so that your clients can install the certificate for trust.
343-
fn new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
343+
fn try_new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
344344
let tls_server_config = ServerConfig {
345345
application_layer_protocol_negotiation: Some(vec![
346346
ApplicationProtocol::HTTP_2,

examples/https_connect_proxy.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ async fn main() {
100100

101101
#[cfg(all(feature = "rustls", not(feature = "boring")))]
102102
let tls_service_data = {
103-
TlsAcceptorDataBuilder::new_self_signed(SelfSignedData {
103+
TlsAcceptorDataBuilder::try_new_self_signed(SelfSignedData {
104104
organisation_name: Some("Example Server Acceptor".to_owned()),
105105
..Default::default()
106106
})

examples/https_web_service_with_hsts.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ async fn main() {
9191

9292
#[cfg(all(feature = "rustls", not(feature = "boring")))]
9393
let tls_service_data = {
94-
TlsAcceptorDataBuilder::new_self_signed(SelfSignedData {
94+
TlsAcceptorDataBuilder::try_new_self_signed(SelfSignedData {
9595
organisation_name: Some("Example Server Acceptor".to_owned()),
9696
..Default::default()
9797
})

examples/socks5_connect_proxy_mitm_proxy.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ async fn main() {
7676
.init();
7777

7878
let mitm_tls_service_data =
79-
new_mitm_tls_service_data().expect("generate self-signed mitm tls cert");
79+
try_new_mitm_tls_service_data().expect("generate self-signed mitm tls cert");
8080

8181
let graceful = rama::graceful::Shutdown::default();
8282

@@ -179,7 +179,7 @@ async fn http_mitm_proxy(req: Request) -> Result<Response, Infallible> {
179179
// NOTE: for a production service you ideally use
180180
// an issued TLS cert (if possible via ACME). Or at the very least
181181
// load it in from memory/file, so that your clients can install the certificate for trust.
182-
fn new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
182+
fn try_new_mitm_tls_service_data() -> Result<TlsAcceptorData, OpaqueError> {
183183
let tls_server_config = ServerConfig {
184184
application_layer_protocol_negotiation: Some(vec![
185185
ApplicationProtocol::HTTP_2,

0 commit comments

Comments
 (0)