add: noting where things are required for builders

Author: anewton1998

icann-rdap-common/src/response/autnum.rs

@@ -90,7 +90,7 @@ impl Autnum {
     /// use icann_rdap_common::prelude::*;
     ///
     /// let autnum = Autnum::builder()
-    ///   .autnum_range(700..710)
+    ///   .autnum_range(700..710)  //required for this builder
     ///   .handle("AS700-1")
     ///   .status("active")
     ///   .build();

icann-rdap-common/src/response/domain.rs

@@ -480,7 +480,7 @@ impl Domain {
     /// use icann_rdap_common::prelude::*;
     ///
     /// let domain = Domain::builder()
-    ///   .ldh_name("foo.example.com")
+    ///   .ldh_name("foo.example.com") //required for this builder.
     ///   .handle("foo_example_com-1")
     ///   .status("active")
     ///   .build();
@@ -536,7 +536,7 @@ impl Domain {
     /// use icann_rdap_common::prelude::*;
     ///
     /// let domain = Domain::idn()
-    ///   .unicode_name("foo.example.com")
+    ///   .unicode_name("foo.example.com") // required for this builder
     ///   .handle("foo_example_com-1")
     ///   .status("active")
     ///   .build();

icann-rdap-common/src/response/error.rs

@@ -55,6 +55,15 @@ pub struct Rfc9083Error {
 #[buildstructor::buildstructor]
 impl Rfc9083Error {
     /// Creates a new RFC 9083 Error for a specific HTTP error code.
+    ///
+    /// Use this builder to create a generic error:
+    /// ```rust
+    /// use icann_rdap_common::prelude::*;
+    ///
+    /// let e = Rfc9083Error::builder()
+    ///   .error_code(500) //required
+    ///   .build();
+    /// ```
     #[builder(visibility = "pub")]
     fn new(error_code: u16, notices: Vec<Notice>, extensions: Vec<Extension>) -> Self {
         let notices = (!notices.is_empty()).then_some(notices);

icann-rdap-common/src/response/nameserver.rs

@@ -161,7 +161,7 @@ impl Nameserver {
     /// use icann_rdap_common::prelude::*;
     ///
     /// let ns = Nameserver::builder()
-    ///   .ldh_name("ns1.example.com")
+    ///   .ldh_name("ns1.example.com") //required for this builder
     ///   .handle("ns1_example_com-1")
     ///   .status("active")
     ///   .address("10.0.0.1")

icann-rdap-common/src/response/network.rs

@@ -237,7 +237,7 @@ impl Network {
     /// use icann_rdap_common::prelude::*;
     ///
     /// let net = Network::builder()
-    ///   .cidr("10.0.0.0/24")
+    ///   .cidr("10.0.0.0/24")     //required for this builder
     ///   .handle("NET-10-0-0-0")
     ///   .status("active")
     ///   .build().unwrap();

icann-rdap-common/src/response/types.rs

@@ -46,15 +46,15 @@ pub type RdapConformance = Vec<Extension>;
 /// println!("{}", cidr0.to_string());
 /// ```
 ///
-/// To get the variants as a string:
+/// To get the enum variants as a string:
 ///
 /// ```rust
 /// use icann_rdap_common::prelude::*;
 ///
 /// let s = ExtensionId::Cidr0.to_string();
 /// ```
 ///
-/// To get the variants as a &str:
+/// To get the enum variants as a &str:
 ///
 /// ```rust
 /// use icann_rdap_common::prelude::*;
@@ -215,6 +215,23 @@ impl Link {
     }
 
     /// Builds an RDAP link.
+    ///
+    /// To create an RFC valid structure, use the builder
+    /// which will not allow omision of required fields.
+    ///
+    /// ```rust
+    /// use icann_rdap_common::prelude::*;
+    ///
+    /// let link = Link::builder()
+    ///   .value("https://example.com/domains?domain=foo.*") //required
+    ///   .rel("related")                                    //required
+    ///   .href("https://example.com/domain/foo.example")    //required
+    ///   .hreflang("ch")
+    ///   .title("Related Object")
+    ///   .media("print")
+    ///   .media_type("application/rdap+json")
+    ///   .build();
+    /// ```
     #[builder(visibility = "pub")]
     fn new(
         value: String,
@@ -586,6 +603,18 @@ pub struct Event {
 #[buildstructor::buildstructor]
 impl Event {
     /// Builds an Event.
+    ///
+    /// Use of the builder to contruct an RFC valid structure is recommended.
+    ///
+    /// ```rust
+    /// use icann_rdap_common::prelude::*;
+    ///
+    /// let event = Event::builder()
+    ///   .event_action("expiration")         //required
+    ///   .event_date("1990-12-31T23:59:59Z") //required
+    ///   .event_actor("FOO")
+    ///   .build();
+    /// ```
     #[builder(visibility = "pub")]
     fn new(
         event_action: String,