Add docs for each error in ssl module

Snowapril · Snowapril · commit fee42a1074f6 · 2021-11-12T21:40:26.000+09:00
Signed-off-by: snowapril &lt;sinjihng@gmail.com&gt;
diff --git a/stdlib/src/ssl.rs b/stdlib/src/ssl.rs
@@ -174,11 +174,13 @@ mod _ssl {
         parse_version_info(openssl_api_version)
     }
 
+    /// An error occurred in the SSL implementation.
     #[pyattr(name = "SSLError", once)]
     fn ssl_error(vm: &VirtualMachine) -> PyTypeRef {
         PyType::new_simple_ref("ssl.SSLError", &vm.ctx.exceptions.os_error).unwrap()
     }
 
+    /// A certificate could not be verified.
     #[pyattr(name = "SSLCertVerificationError", once)]
     fn ssl_cert_verification_error(vm: &VirtualMachine) -> PyTypeRef {
         let ssl_error = ssl_error(vm);
@@ -192,26 +194,31 @@ mod _ssl {
         .unwrap()
     }
 
+    /// SSL/TLS session closed cleanly.
     #[pyattr(name = "SSLZeroReturnError", once)]
     fn ssl_zero_return_error(vm: &VirtualMachine) -> PyTypeRef {
         PyType::new_simple_ref("ssl.SSLZeroReturnError", &ssl_error(vm)).unwrap()
     }
 
+    /// Non-blocking SSL socket needs to read more data before the requested operation can be completed.
     #[pyattr(name = "SSLWantReadError", once)]
     fn ssl_want_read_error(vm: &VirtualMachine) -> PyTypeRef {
         PyType::new_simple_ref("ssl.SSLWantReadError", &ssl_error(vm)).unwrap()
     }
 
+    /// Non-blocking SSL socket needs to write more data before the requested operation can be completed.
     #[pyattr(name = "SSLWantWriteError", once)]
     fn ssl_want_write_error(vm: &VirtualMachine) -> PyTypeRef {
         PyType::new_simple_ref("ssl.SSLWantWriteError", &ssl_error(vm)).unwrap()
     }
 
+    /// System error when attempting SSL operation.
     #[pyattr(name = "SSLSyscallError", once)]
     fn ssl_syscall_error(vm: &VirtualMachine) -> PyTypeRef {
         PyType::new_simple_ref("ssl.SSLSyscallError", &ssl_error(vm)).unwrap()
     }
 
+    /// SSL/TLS connection terminated abruptly.
     #[pyattr(name = "SSLEOFError", once)]
     fn ssl_eof_error(vm: &VirtualMachine) -> PyTypeRef {
         PyType::new_simple_ref("ssl.SSLEOFError", &ssl_error(vm)).unwrap()

Original file line number	Diff line number	Diff line change
`@@ -174,11 +174,13 @@ mod _ssl {`
`174`	`174`	`parse_version_info(openssl_api_version)`
`175`	`175`	`}`
`176`	`176`
	`177`	`+ /// An error occurred in the SSL implementation.`
`177`	`178`	`#[pyattr(name = "SSLError", once)]`
`178`	`179`	`fn ssl_error(vm: &VirtualMachine) -> PyTypeRef {`
`179`	`180`	`PyType::new_simple_ref("ssl.SSLError", &vm.ctx.exceptions.os_error).unwrap()`
`180`	`181`	`}`
`181`	`182`
	`183`	`+ /// A certificate could not be verified.`
`182`	`184`	`#[pyattr(name = "SSLCertVerificationError", once)]`
`183`	`185`	`fn ssl_cert_verification_error(vm: &VirtualMachine) -> PyTypeRef {`
`184`	`186`	`let ssl_error = ssl_error(vm);`
`@@ -192,26 +194,31 @@ mod _ssl {`
`192`	`194`	`.unwrap()`
`193`	`195`	`}`
`194`	`196`
	`197`	`+ /// SSL/TLS session closed cleanly.`
`195`	`198`	`#[pyattr(name = "SSLZeroReturnError", once)]`
`196`	`199`	`fn ssl_zero_return_error(vm: &VirtualMachine) -> PyTypeRef {`
`197`	`200`	`PyType::new_simple_ref("ssl.SSLZeroReturnError", &ssl_error(vm)).unwrap()`
`198`	`201`	`}`
`199`	`202`
	`203`	`+ /// Non-blocking SSL socket needs to read more data before the requested operation can be completed.`
`200`	`204`	`#[pyattr(name = "SSLWantReadError", once)]`
`201`	`205`	`fn ssl_want_read_error(vm: &VirtualMachine) -> PyTypeRef {`
`202`	`206`	`PyType::new_simple_ref("ssl.SSLWantReadError", &ssl_error(vm)).unwrap()`
`203`	`207`	`}`
`204`	`208`
	`209`	`+ /// Non-blocking SSL socket needs to write more data before the requested operation can be completed.`
`205`	`210`	`#[pyattr(name = "SSLWantWriteError", once)]`
`206`	`211`	`fn ssl_want_write_error(vm: &VirtualMachine) -> PyTypeRef {`
`207`	`212`	`PyType::new_simple_ref("ssl.SSLWantWriteError", &ssl_error(vm)).unwrap()`
`208`	`213`	`}`
`209`	`214`
	`215`	`+ /// System error when attempting SSL operation.`
`210`	`216`	`#[pyattr(name = "SSLSyscallError", once)]`
`211`	`217`	`fn ssl_syscall_error(vm: &VirtualMachine) -> PyTypeRef {`
`212`	`218`	`PyType::new_simple_ref("ssl.SSLSyscallError", &ssl_error(vm)).unwrap()`
`213`	`219`	`}`
`214`	`220`
	`221`	`+ /// SSL/TLS connection terminated abruptly.`
`215`	`222`	`#[pyattr(name = "SSLEOFError", once)]`
`216`	`223`	`fn ssl_eof_error(vm: &VirtualMachine) -> PyTypeRef {`
`217`	`224`	`PyType::new_simple_ref("ssl.SSLEOFError", &ssl_error(vm)).unwrap()`