Code review notes

Name macro to reflect underlying NGINX type

Author: Matthew Yacobucci

src/http/request.rs

@@ -1,6 +1,6 @@
 use crate::core::*;
 use crate::ffi::*;
-use crate::http::status::*;
+use crate::http::{status::*, Upstream};
 use crate::ngx_null_string;
 use std::fmt;
 use std::os::raw::c_void;
@@ -117,13 +117,17 @@ impl Request {
 
     /// Returns the result as an `Option` if it exists, otherwise `None`.
     ///
-    /// The option wraps a pointer to a [`ngx_http_upstream_t`] upstream server object.
+    /// The option wraps an Upstream instance, it will be none when the underlying NGINX request
+    /// does not have a pointer to a [`ngx_http_upstream_t`] upstream structure.
     ///
     /// [`ngx_http_upstream_t`]: is best described in
     /// https://nginx.org/en/docs/dev/development_guide.html#http_request
     /// https://nginx.org/en/docs/dev/development_guide.html#http_load_balancing
-    pub fn upstream(&self) -> Option<*mut ngx_http_upstream_t> {
-        Some(self.0.upstream)
+    pub fn upstream(&self) -> Option<&mut Upstream> {
+        if self.0.upstream.is_null() {
+            return None;
+        }
+        Some(unsafe { Upstream::from_ngx_http_upstream(self.0.upstream) })
     }
 
     /// Pointer to a [`ngx_connection_t`] client connection object.

src/http/upstream.rs

@@ -2,9 +2,15 @@
 ///
 /// Initializes the upstream 'get', 'free', and 'session' callbacks and gives the module writer an
 /// opportunity to set custom data.
+///
+/// This macro will define the NGINX callback type:
+/// `typedef ngx_int_t (*ngx_http_upstream_init_peer_pt)(ngx_http_request_t *r, ngx_http_upstream_srv_conf_t *us)`,
+/// we keep this macro name in-sync with its underlying NGINX type, this callback is required to
+/// initialize your peer.
+///
 /// Load Balancing: <https://nginx.org/en/docs/dev/development_guide.html#http_load_balancing>
 #[macro_export]
-macro_rules! http_upstream_peer_init {
+macro_rules! http_upstream_init_peer_pt {
     ( $name: ident, $handler: expr ) => {
         #[no_mangle]
         extern "C" fn $name(r: *mut ngx_http_request_t, us: *mut ngx_http_upstream_srv_conf_t) -> ngx_int_t {