diff --git a/src/common.rs b/src/common.rs index d32d773..21bc53e 100644 --- a/src/common.rs +++ b/src/common.rs @@ -32,7 +32,7 @@ impl Extension for NoExtension { type Response = NoExtension; } -/// The type in EPP XML login requests +/// The `` type in EPP XML login requests #[derive(Debug, Eq, FromXml, PartialEq, ToXml)] #[xml(rename = "options", ns(EPP_XMLNS))] pub struct Options<'a> { @@ -52,23 +52,23 @@ impl<'a> Options<'a> { } } -/// The type in EPP XML +/// The `` type in EPP XML #[derive(Debug, Eq, FromXml, PartialEq, ToXml)] #[xml(rename = "svcExtension", ns(EPP_XMLNS))] pub struct ServiceExtension<'a> { - /// The service extension URIs being represented by in EPP XML + /// The service extension URIs being represented by `` in EPP XML #[xml(rename = "extURI")] pub ext_uris: Option>>, } -/// The type in EPP XML +/// The `` type in EPP XML #[derive(Debug, Eq, FromXml, PartialEq, ToXml)] #[xml(rename = "svcs", ns(EPP_XMLNS))] pub struct Services<'a> { - /// The service URIs being used by this EPP session represented by in EPP XML + /// The service URIs being used by this EPP session represented by `` in EPP XML #[xml(rename = "objURI")] pub obj_uris: Vec>, - // The being used in this EPP session + // The `` being used in this EPP session #[xml(rename = "svcExtension")] pub svc_ext: Option>, } diff --git a/src/contact/check.rs b/src/contact/check.rs index 23b63a9..bcaacf2 100644 --- a/src/contact/check.rs +++ b/src/contact/check.rs @@ -17,7 +17,7 @@ impl<'a> Command for ContactCheck<'a> { // Request -/// Type that represents the <check> command for contact transactions +/// Type that represents the `` command for contact transactions #[derive(Debug, ToXml)] #[xml(rename = "check", ns(XMLNS))] struct ContactList<'a> { @@ -56,11 +56,11 @@ pub struct Checked { #[derive(Debug, FromXml)] #[xml(rename = "cd", ns(XMLNS))] pub struct CheckedContact { - /// Data under the <cd> tag + /// Data under the `` tag pub inner: Checked, } -/// Type that represents the <chkData> tag for host check response +/// Type that represents the `` tag for host check response #[derive(Debug, FromXml)] #[xml(rename = "chkData", ns(XMLNS))] pub struct CheckData { diff --git a/src/contact/create.rs b/src/contact/create.rs index 973400a..9692c7a 100644 --- a/src/contact/create.rs +++ b/src/contact/create.rs @@ -16,29 +16,29 @@ impl<'a> Command for ContactCreate<'a> { // Request -/// Type for elements under the contact <create> tag +/// Type for elements under the contact `` tag #[derive(Debug, ToXml)] #[xml(rename = "create", ns(XMLNS))] pub struct ContactCreateRequest<'a> { - /// Contact <id> tag + /// Contact `` tag id: &'a str, - /// Contact <postalInfo> tag + /// Contact `` tag postal_info: PostalInfo<'a>, - /// Contact <voice> tag + /// Contact `` tag voice: Voice<'a>, - /// Contact <fax> tag,] + /// Contact `` tag,] fax: Option>, - /// Contact <email> tag + /// Contact `` tag email: &'a str, - /// Contact <authInfo> tag + /// Contact `` tag auth_info: ContactAuthInfo<'a>, } -/// Type for EPP XML <create> command for contacts +/// Type for EPP XML `` command for contacts #[derive(Debug, ToXml)] #[xml(rename = "create", ns(EPP_XMLNS))] pub struct ContactCreate<'a> { - /// Data for <create> command for contact + /// Data for `` command for contact pub contact: ContactCreateRequest<'a>, } @@ -62,7 +62,7 @@ impl<'a> ContactCreate<'a> { } } - /// Sets the <fax> data for the request + /// Sets the `` data for the request pub fn set_fax(&mut self, fax: Fax<'a>) { self.contact.fax = Some(fax); } @@ -70,7 +70,7 @@ impl<'a> ContactCreate<'a> { // Response -/// Type that represents the <creData> tag for contact create response +/// Type that represents the `` tag for contact create response #[derive(Debug, FromXml)] #[xml(rename = "creData", ns(XMLNS))] pub struct CreateData { diff --git a/src/contact/delete.rs b/src/contact/delete.rs index 9438f29..49afc80 100644 --- a/src/contact/delete.rs +++ b/src/contact/delete.rs @@ -13,7 +13,7 @@ impl<'a> Command for ContactDelete<'a> { const COMMAND: &'static str = "delete"; } -/// Type containing the data for the <delete> tag for contacts +/// Type containing the data for the `` tag for contacts #[derive(Debug, ToXml)] #[xml(rename = "delete", ns(XMLNS))] pub struct ContactDeleteRequest<'a> { @@ -21,11 +21,11 @@ pub struct ContactDeleteRequest<'a> { id: &'a str, } -/// The <delete> type for the contact delete EPP command +/// The `` type for the contact delete EPP command #[derive(Debug, ToXml)] #[xml(rename = "delete", ns(EPP_XMLNS))] pub struct ContactDelete<'a> { - /// The data for the <delete> tag for a contact delete command + /// The data for the `` tag for a contact delete command contact: ContactDeleteRequest<'a>, } diff --git a/src/contact/info.rs b/src/contact/info.rs index d71eba9..103495c 100644 --- a/src/contact/info.rs +++ b/src/contact/info.rs @@ -16,21 +16,21 @@ impl<'a> Command for ContactInfo<'a> { // Request -/// Type for elements under the contact <info> tag +/// Type for elements under the contact `` tag #[derive(Debug, ToXml)] #[xml(rename = "info", ns(XMLNS))] pub struct ContactInfoRequest<'a> { /// The contact id for the info command id: &'a str, - /// The <authInfo> data + /// The `` data auth_info: ContactAuthInfo<'a>, } -/// Type for EPP XML <info> command for contacts +/// Type for EPP XML `` command for contacts #[derive(Debug, ToXml)] #[xml(rename = "info", ns(EPP_XMLNS))] pub struct ContactInfo<'a> { - /// Data for <info> command for contact + /// Data for `` command for contact info: ContactInfoRequest<'a>, } @@ -47,7 +47,7 @@ impl<'a> ContactInfo<'a> { // Response -/// Type that represents the <infData> tag for contact check response +/// Type that represents the `` tag for contact check response #[derive(Debug, FromXml)] #[xml(rename = "infData", ns(XMLNS))] pub struct InfoData { diff --git a/src/contact/mod.rs b/src/contact/mod.rs index 3279470..e4e3071 100644 --- a/src/contact/mod.rs +++ b/src/contact/mod.rs @@ -74,11 +74,11 @@ impl std::ops::Deref for Country { } } -/// The <authInfo> tag for domain and contact transactions +/// The `` tag for domain and contact transactions #[derive(Debug, Clone, FromXml, ToXml)] #[xml(rename = "authInfo", ns(XMLNS))] pub struct ContactAuthInfo<'a> { - /// The <pw> tag under <authInfo> + /// The `` tag under `` #[xml(rename = "pw")] pub password: Cow<'a, str>, } @@ -92,14 +92,14 @@ impl<'a> ContactAuthInfo<'a> { } } -/// The data for <voice> types on domain transactions +/// The data for `` types on domain transactions #[derive(Debug, Clone, FromXml, ToXml)] #[xml(rename = "voice", ns(XMLNS))] pub struct Voice<'a> { - /// The value of the 'x' attr on <voice> and <fax> tags + /// The value of the 'x' attr on `` and `` tags #[xml(rename = "x", attribute)] pub extension: Option>, - /// The inner text on the <voice> and <fax> tags + /// The inner text on the `` and `` tags #[xml(direct)] pub number: Cow<'a, str>, } @@ -119,14 +119,14 @@ impl<'a> Voice<'a> { } } -/// The data for <voice> and <fax> types on domain transactions +/// The data for `` and `` types on domain transactions #[derive(Debug, Clone, FromXml, ToXml)] #[xml(rename = "fax", ns(XMLNS))] pub struct Fax<'a> { - /// The value of the 'x' attr on <voice> and <fax> tags + /// The value of the 'x' attr on `` and `` tags #[xml(rename = "x", attribute)] pub extension: Option>, - /// The inner text on the <voice> and <fax> tags + /// The inner text on the `` and `` tags #[xml(direct)] pub number: Cow<'a, str>, } @@ -146,21 +146,21 @@ impl<'a> Fax<'a> { } } -/// The <addr> type on contact transactions +/// The `` type on contact transactions #[derive(Debug, Clone, FromXml, ToXml)] #[xml(rename = "addr", ns(XMLNS))] pub struct Address<'a> { - /// The <street> tags under <addr> + /// The `` tags under `` pub street: Vec>, - /// The <city> tag under <addr> + /// The `` tag under `` pub city: Cow<'a, str>, - /// The <sp> tag under <addr> + /// The `` tag under `` #[xml(rename = "sp")] pub province: Cow<'a, str>, - /// The <pc> tag under <addr> + /// The `` tag under `` #[xml(rename = "pc")] pub postal_code: Cow<'a, str>, - /// The <cc> tag under <addr> + /// The `` tag under `` #[xml(rename = "cc")] pub country: Country, } @@ -186,19 +186,19 @@ impl<'a> Address<'a> { } } -/// The <postalInfo> type on contact transactions +/// The `` type on contact transactions #[derive(Debug, Clone, FromXml, ToXml)] #[xml(rename = "postalInfo", ns(XMLNS))] pub struct PostalInfo<'a> { - /// The 'type' attr on <postalInfo> + /// The 'type' attr on `` #[xml(rename = "type", attribute)] pub info_type: Cow<'a, str>, - /// The <name> tag under <postalInfo> + /// The `` tag under `` pub name: Cow<'a, str>, - /// The <org> tag under <postalInfo> + /// The `` tag under `` #[xml(rename = "org")] pub organization: Cow<'a, str>, - /// The <addr> tag under <postalInfo> + /// The `` tag under `` pub address: Address<'a>, } @@ -219,11 +219,11 @@ impl<'a> PostalInfo<'a> { } } -/// The <status> type on contact transactions +/// The `` type on contact transactions #[derive(Debug, FromXml, ToXml)] #[xml(rename = "status", ns(XMLNS))] pub struct Status<'a> { - /// The status name, represented by the 's' attr on <status> tags + /// The status name, represented by the 's' attr on `` tags #[xml(attribute, rename = "s")] pub status: Cow<'a, str>, } diff --git a/src/contact/update.rs b/src/contact/update.rs index 5d0519b..72f8e39 100644 --- a/src/contact/update.rs +++ b/src/contact/update.rs @@ -25,7 +25,7 @@ impl<'a> ContactUpdate<'a> { } } - /// Sets the data for the <chg> tag for the contact update request + /// Sets the data for the `` tag for the contact update request pub fn set_info( &mut self, email: &'a str, @@ -42,25 +42,25 @@ impl<'a> ContactUpdate<'a> { }); } - /// Sets the data for the <fax> tag under <chg> for the contact update request + /// Sets the data for the `` tag under `` for the contact update request pub fn set_fax(&mut self, fax: Fax<'a>) { if let Some(info) = &mut self.contact.change_info { info.fax = Some(fax) } } - /// Sets the data for the <add> tag for the contact update request + /// Sets the data for the `` tag for the contact update request pub fn add(&mut self, statuses: &'a [Status]) { self.contact.add_statuses = Some(AddStatuses { statuses }); } - /// Sets the data for the <rem> tag for the contact update request + /// Sets the data for the `` tag for the contact update request pub fn remove(&mut self, statuses: &'a [Status]) { self.contact.remove_statuses = Some(RemoveStatuses { statuses }); } } -/// Type for elements under the <chg> tag for contact update request +/// Type for elements under the `` tag for contact update request #[derive(Debug, ToXml)] #[xml(rename = "chg", ns(XMLNS))] pub struct ContactChangeInfo<'a> { @@ -71,7 +71,7 @@ pub struct ContactChangeInfo<'a> { auth_info: Option>, } -/// Type for list of elements of the <status> tag for contact update request +/// Type for list of elements of the `` tag for contact update request #[derive(Debug, ToXml)] pub struct StatusList<'a> { status: &'a [Status<'a>], @@ -89,7 +89,7 @@ struct RemoveStatuses<'a> { statuses: &'a [Status<'a>], } -/// Type for elements under the contact <update> tag +/// Type for elements under the contact `` tag #[derive(Debug, ToXml)] #[xml(rename = "update", ns(XMLNS))] pub struct ContactUpdateRequest<'a> { @@ -100,11 +100,11 @@ pub struct ContactUpdateRequest<'a> { change_info: Option>, } -/// Type for EPP XML <update> command for contacts +/// Type for EPP XML `` command for contacts #[derive(Debug, ToXml)] #[xml(rename = "update", ns(EPP_XMLNS))] pub struct ContactUpdate<'a> { - /// The data under the <update> tag for the contact update + /// The data under the `` tag for the contact update contact: ContactUpdateRequest<'a>, } diff --git a/src/domain/check.rs b/src/domain/check.rs index 4e8bdca..071b79e 100644 --- a/src/domain/check.rs +++ b/src/domain/check.rs @@ -55,12 +55,12 @@ pub struct Checked { #[derive(Debug, FromXml)] #[xml(rename = "cd", ns(XMLNS))] pub struct CheckedDomain { - /// Data under the <cd> tag + /// Data under the `` tag #[xml(rename = "cd")] pub inner: Checked, } -/// Type that represents the <chkData> tag for host check response +/// Type that represents the `` tag for host check response #[derive(Debug, FromXml)] #[xml(rename = "chkData", ns(XMLNS))] pub struct CheckData { diff --git a/src/domain/create.rs b/src/domain/create.rs index 13d695c..b1fef2e 100644 --- a/src/domain/create.rs +++ b/src/domain/create.rs @@ -16,7 +16,7 @@ impl<'a> Command for DomainCreate<'a> { // Request -/// Type for elements under the domain <create> tag +/// Type for elements under the domain `` tag #[derive(Debug, ToXml)] #[xml(rename = "create", ns(XMLNS))] pub struct DomainCreateRequestData<'a> { @@ -36,7 +36,7 @@ pub struct DomainCreateRequestData<'a> { } #[derive(Debug, ToXml)] -/// Type for EPP XML <create> command for domains +/// Type for EPP XML `` command for domains #[xml(rename = "create", ns(EPP_XMLNS))] pub struct DomainCreate<'a> { /// The data for the domain to be created with @@ -69,7 +69,7 @@ impl<'a> DomainCreate<'a> { // Response -/// Type that represents the <chkData> tag for domain create response +/// Type that represents the `` tag for domain create response #[derive(Debug, FromXml)] #[xml(rename = "creData", ns(XMLNS))] pub struct CreateData { diff --git a/src/domain/delete.rs b/src/domain/delete.rs index 5904c79..db235f6 100644 --- a/src/domain/delete.rs +++ b/src/domain/delete.rs @@ -21,7 +21,7 @@ impl<'a> DomainDelete<'a> { } } -/// Type for <name> element under the domain <delete> tag +/// Type for `` element under the domain `` tag #[derive(Debug, ToXml)] #[xml(rename = "delete", ns(XMLNS))] pub struct DomainDeleteRequestData<'a> { @@ -30,10 +30,10 @@ pub struct DomainDeleteRequestData<'a> { } #[derive(Debug, ToXml)] -/// Type for EPP XML <delete> command for domains +/// Type for EPP XML `` command for domains #[xml(rename = "delete", ns(EPP_XMLNS))] pub struct DomainDelete<'a> { - /// The data under the <delete> tag for domain deletion + /// The data under the `` tag for domain deletion domain: DomainDeleteRequestData<'a>, } diff --git a/src/domain/info.rs b/src/domain/info.rs index f7912c6..1bcb7a3 100644 --- a/src/domain/info.rs +++ b/src/domain/info.rs @@ -29,7 +29,7 @@ impl<'a> DomainInfo<'a> { // Request -/// Type for data under the <name> element tag for the domain <info> tag +/// Type for data under the `` element tag for the domain `` tag #[derive(Debug, ToXml)] #[xml(rename = "name", ns(XMLNS))] pub struct Domain<'a> { @@ -41,7 +41,7 @@ pub struct Domain<'a> { name: &'a str, } -/// Type for <name> element under the domain <info> tag +/// Type for `` element under the domain `` tag #[derive(Debug, ToXml)] #[xml(rename = "info", ns(XMLNS))] pub struct DomainInfoRequestData<'a> { @@ -52,10 +52,10 @@ pub struct DomainInfoRequestData<'a> { } #[derive(Debug, ToXml)] -/// Type for EPP XML <info> command for domains +/// Type for EPP XML `` command for domains #[xml(rename = "info", ns(EPP_XMLNS))] pub struct DomainInfo<'a> { - /// The data under the <info> tag for domain info + /// The data under the `` tag for domain info info: DomainInfoRequestData<'a>, } @@ -65,14 +65,14 @@ pub struct DomainInfo<'a> { /// domain info response #[derive(Debug, FromXml)] pub struct DomainNsList { - /// List of <hostObj> ns elements + /// List of `` ns elements #[xml(rename = "hostObj")] pub host_obj: Option>, - /// List of <hostAttr> ns elements + /// List of `` ns elements pub host_attr: Option>>, } -/// Type that represents the <infData> tag for domain info response +/// Type that represents the `` tag for domain info response #[derive(Debug, FromXml)] #[xml(rename = "infData", ns(XMLNS))] pub struct InfoData { diff --git a/src/domain/mod.rs b/src/domain/mod.rs index 06ff688..6461fab 100644 --- a/src/domain/mod.rs +++ b/src/domain/mod.rs @@ -35,14 +35,14 @@ pub use update::DomainUpdate; pub const XMLNS: &str = "urn:ietf:params:xml:ns:domain-1.0"; -/// The <hostAttr> type for domain transactions +/// The `` type for domain transactions #[derive(Clone, Debug, Eq, FromXml, PartialEq, ToXml)] #[xml(rename = "hostAttr", ns(XMLNS))] pub struct HostAttr<'a> { - /// The <hostName> tag + /// The `` tag #[xml(rename = "hostName")] pub name: Cow<'a, str>, - /// The <hostAddr> tags + /// The `` tags #[xml( rename = "hostAddr", serialize_with = "serialize_host_addrs_option", @@ -79,7 +79,7 @@ fn deserialize_host_addrs_option<'xml>( Ok(()) } -/// The <hostAddr> types domain or host transactions +/// The `` types domain or host transactions #[derive(Debug, FromXml, ToXml)] #[xml(rename = "hostAddr", ns(super::domain::XMLNS))] pub(crate) struct HostAddr<'a> { @@ -137,7 +137,7 @@ pub struct NameServers<'a> { pub ns: Cow<'a, [HostInfo<'a>]>, } -/// The <contact> type on domain creation and update requests +/// The `` type on domain creation and update requests #[derive(Debug, FromXml, ToXml)] #[xml(rename = "contact", ns(XMLNS))] pub struct DomainContact<'a> { @@ -149,7 +149,7 @@ pub struct DomainContact<'a> { pub id: Cow<'a, str>, } -/// The <period> type for registration, renewal or transfer on domain transactions +/// The `` type for registration, renewal or transfer on domain transactions #[derive(Clone, Copy, Debug, ToXml)] #[xml(rename = "period", ns(XMLNS))] pub struct Period { @@ -205,11 +205,11 @@ pub const SIX_MONTHS: Period = Period { length: 6, }; -/// The <authInfo> tag for domain and contact transactions +/// The `` tag for domain and contact transactions #[derive(Clone, Debug, FromXml, ToXml)] #[xml(rename = "authInfo", ns(XMLNS))] pub struct DomainAuthInfo<'a> { - /// The <pw> tag under <authInfo> + /// The `` tag under `` #[xml(rename = "pw")] pub password: Cow<'a, str>, } @@ -223,11 +223,11 @@ impl<'a> DomainAuthInfo<'a> { } } -/// The <status> type on contact transactions +/// The `` type on contact transactions #[derive(Debug, FromXml, ToXml)] #[xml(rename = "status", ns(XMLNS))] pub struct Status<'a> { - /// The status name, represented by the 's' attr on <status> tags + /// The status name, represented by the 's' attr on `` tags #[xml(attribute, rename = "s")] pub status: Cow<'a, str>, } diff --git a/src/domain/renew.rs b/src/domain/renew.rs index 965226f..6318de9 100644 --- a/src/domain/renew.rs +++ b/src/domain/renew.rs @@ -28,7 +28,7 @@ impl<'a> DomainRenew<'a> { // Request -/// Type for data under the domain <renew> tag +/// Type for data under the domain `` tag #[derive(Debug, ToXml)] #[xml(rename = "renew", ns(XMLNS))] pub struct DomainRenewRequestData<'a> { @@ -42,17 +42,17 @@ pub struct DomainRenewRequestData<'a> { } #[derive(Debug, ToXml)] -/// Type for EPP XML <renew> command for domains +/// Type for EPP XML `` command for domains #[xml(rename = "renew", ns(EPP_XMLNS))] pub struct DomainRenew<'a> { - /// The data under the <renew> tag for the domain renewal + /// The data under the `` tag for the domain renewal #[xml(rename = "renew")] domain: DomainRenewRequestData<'a>, } // Response -/// Type that represents the <renData> tag for domain renew response +/// Type that represents the `` tag for domain renew response #[derive(Debug, FromXml)] #[xml(rename = "renData", ns(XMLNS))] pub struct RenewData { diff --git a/src/domain/transfer.rs b/src/domain/transfer.rs index c1efd73..fe9dadc 100644 --- a/src/domain/transfer.rs +++ b/src/domain/transfer.rs @@ -64,7 +64,7 @@ impl<'a> DomainTransfer<'a> { // Request -/// Type for elements under the domain <transfer> tag +/// Type for elements under the domain `` tag #[derive(Debug, ToXml)] #[xml(rename = "transfer", ns(XMLNS))] pub struct DomainTransferReqData<'a> { @@ -81,19 +81,19 @@ pub struct DomainTransferReqData<'a> { #[derive(Debug, ToXml)] #[xml(rename = "transfer", ns(EPP_XMLNS))] -/// Type for EPP XML <transfer> command for domains +/// Type for EPP XML `` command for domains pub struct DomainTransfer<'a> { /// The transfer operation to perform indicated by the 'op' attr /// The values are one of transfer or query #[xml(rename = "op", attribute)] operation: &'a str, - /// The data under the <transfer> tag in the transfer request + /// The data under the `` tag in the transfer request domain: DomainTransferReqData<'a>, } // Response -/// Type that represents the <trnData> tag for domain transfer response +/// Type that represents the `` tag for domain transfer response #[derive(Debug, FromXml)] #[xml(rename = "trnData", ns(XMLNS))] pub struct TransferData { diff --git a/src/domain/update.rs b/src/domain/update.rs index 954e1c9..b452125 100644 --- a/src/domain/update.rs +++ b/src/domain/update.rs @@ -27,23 +27,23 @@ impl<'a> DomainUpdate<'a> { } } - /// Sets the data for the <chg> tag + /// Sets the data for the `` tag pub fn info(&mut self, info: DomainChangeInfo<'a>) { self.domain.change_info = Some(info); } - /// Sets the data for the <add> tag + /// Sets the data for the `` tag pub fn add(&mut self, add: DomainAdd<'a>) { self.domain.add = Some(add); } - /// Sets the data for the <rem> tag + /// Sets the data for the `` tag pub fn remove(&mut self, remove: DomainRemove<'a>) { self.domain.remove = Some(remove); } } -/// Type for elements under the <chg> tag for domain update +/// Type for elements under the `` tag for domain update #[derive(Debug, ToXml)] #[xml(rename = "chg", ns(XMLNS))] pub struct DomainChangeInfo<'a> { @@ -53,7 +53,7 @@ pub struct DomainChangeInfo<'a> { pub auth_info: Option>, } -/// Type for elements under the <add> and <rem> tags for domain update +/// Type for elements under the `` and `` tags for domain update #[derive(Debug, ToXml)] #[xml(rename = "add", ns(XMLNS))] pub struct DomainAdd<'a> { @@ -66,7 +66,7 @@ pub struct DomainAdd<'a> { pub statuses: Option<&'a [Status<'a>]>, } -/// Type for elements under the <add> and <rem> tags for domain update +/// Type for elements under the `` and `` tags for domain update #[derive(Debug, ToXml)] #[xml(rename = "rem", ns(XMLNS))] pub struct DomainRemove<'a> { @@ -79,7 +79,7 @@ pub struct DomainRemove<'a> { pub statuses: Option<&'a [Status<'a>]>, } -/// Type for elements under the <update> tag for domain update +/// Type for elements under the `` tag for domain update #[derive(Debug, ToXml)] #[xml(rename = "update", ns(XMLNS))] pub struct DomainUpdateRequestData<'a> { @@ -91,12 +91,12 @@ pub struct DomainUpdateRequestData<'a> { /// `DomainAddRemove` Object containing the list of elements to be removed /// from the domain pub remove: Option>, - /// The data under the <chg> tag for domain update + /// The data under the `` tag for domain update #[xml(rename = "domain:chg")] pub change_info: Option>, } -/// Type for EPP XML <update> command for domains +/// Type for EPP XML `` command for domains #[derive(Debug, ToXml)] #[xml(rename = "update", ns(EPP_XMLNS))] pub struct DomainUpdate<'a> { diff --git a/src/extensions/consolidate.rs b/src/extensions/consolidate.rs index 4310b52..81592de 100644 --- a/src/extensions/consolidate.rs +++ b/src/extensions/consolidate.rs @@ -94,7 +94,7 @@ pub struct UpdateWithNameStore<'a> { pub namestore: NameStore<'a>, } -/// Type for EPP XML <consolidate> extension +/// Type for EPP XML `` extension #[derive(Debug, ToXml)] #[xml(rename = "update", ns(XMLNS))] pub struct Update { diff --git a/src/extensions/low_balance.rs b/src/extensions/low_balance.rs index 43b2e81..6e71555 100644 --- a/src/extensions/low_balance.rs +++ b/src/extensions/low_balance.rs @@ -1,6 +1,6 @@ //! Low Balance Mapping for the Extensible Provisioning Protocol (EPP) //! -//! https://www.verisign.com/assets/epp-sdk/verisign_epp-extension_low-balance_v01.html +//! use instant_xml::FromXml; diff --git a/src/extensions/namestore.rs b/src/extensions/namestore.rs index 5c95e69..d9002bd 100644 --- a/src/extensions/namestore.rs +++ b/src/extensions/namestore.rs @@ -64,7 +64,7 @@ impl<'a> Extension for NameStore<'a> { } #[derive(Debug, FromXml, ToXml)] -/// Type for EPP XML <namestoreExt> extension +/// Type for EPP XML `` extension #[xml(rename = "namestoreExt", ns(XMLNS))] pub struct NameStore<'a> { /// The object holding the list of domains to be checked diff --git a/src/extensions/rgp/report.rs b/src/extensions/rgp/report.rs index 43c3eb3..51d8fe7 100644 --- a/src/extensions/rgp/report.rs +++ b/src/extensions/rgp/report.rs @@ -47,7 +47,7 @@ pub struct Update { pub data: T, } -/// Type corresponding to the <report> section in the EPP rgp restore extension +/// Type corresponding to the `` section in the EPP rgp restore extension #[derive(Debug, ToXml)] #[xml(rename = "report", ns(XMLNS))] pub struct RgpRestoreReportSectionData<'a> { @@ -75,13 +75,13 @@ pub struct RgpRestoreReportSectionData<'a> { } #[derive(Debug, ToXml)] -/// Type for EPP XML <check> command for domains +/// Type for EPP XML `` command for domains #[xml(rename = "restore", ns(XMLNS))] pub struct RgpRestoreReport<'a> { - /// The value of the op attribute for the <restore> tag + /// The value of the op attribute for the `` tag #[xml(attribute)] op: &'a str, - /// Data for the <report> tag + /// Data for the `` tag #[xml(rename = "rgp:report")] report: RgpRestoreReportSectionData<'a>, } diff --git a/src/extensions/rgp/request.rs b/src/extensions/rgp/request.rs index c5c2daa..f994c75 100644 --- a/src/extensions/rgp/request.rs +++ b/src/extensions/rgp/request.rs @@ -25,11 +25,11 @@ pub struct Update { pub data: T, } -/// Type corresponding to the <restore> tag for an rgp restore request +/// Type corresponding to the `` tag for an rgp restore request #[derive(Debug, ToXml)] #[xml(rename = "restore", ns(XMLNS))] pub struct RgpRestoreRequest<'a> { - /// The value of the op attribute in the <restore> tag + /// The value of the op attribute in the `` tag #[xml(attribute)] pub op: &'a str, } @@ -42,7 +42,7 @@ impl Default for RgpRestoreRequest<'static> { // Response -/// Type that represents the <rgpStatus> tag for domain rgp restore request response +/// Type that represents the `` tag for domain rgp restore request response #[derive(Debug, FromXml)] #[xml(rename = "rgpStatus", ns(XMLNS))] pub struct RgpStatus { @@ -53,21 +53,21 @@ pub struct RgpStatus { #[derive(Debug, FromXml)] #[xml(rename = "upData", ns(XMLNS))] -/// Type that represents the <resData> tag for domain transfer response +/// Type that represents the `` tag for domain transfer response pub struct RgpRequestUpdateResponse { - /// Data under the <rgpStatus> tag + /// Data under the `` tag pub rgp_status: Vec, } #[derive(Debug, FromXml)] #[xml(rename = "infData", ns(XMLNS))] -/// Type that represents the <resData> tag for domain transfer response +/// Type that represents the `` tag for domain transfer response pub struct RgpRequestInfoResponse { - /// Data under the <rgpStatus> tag + /// Data under the `` tag pub rgp_status: Vec, } -/// Type that represents the <resData> tag for domain transfer response +/// Type that represents the `` tag for domain transfer response #[derive(Debug, FromXml)] #[xml(forward)] pub enum RgpRequestResponse { diff --git a/src/hello.rs b/src/hello.rs index bb6bba7..0f8a811 100644 --- a/src/hello.rs +++ b/src/hello.rs @@ -13,7 +13,7 @@ pub(crate) struct Hello; // Response -/// Type for data within the section of an EPP greeting +/// Type for data within the `` section of an EPP greeting #[derive(Debug, Eq, PartialEq)] pub struct ServiceMenu { pub options: Options<'static>, @@ -37,7 +37,7 @@ impl<'xml> FromXml<'xml> for ServiceMenu { FlattenedServiceMenu::matches(id, field) } - /// Deserializes the data to the `ServiceMenu` type + /// Deserializes the `` data to the `ServiceMenu` type fn deserialize<'cx>( into: &mut Self::Accumulator, field: &'static str, @@ -70,51 +70,51 @@ impl<'xml> FromXml<'xml> for ServiceMenu { const KIND: instant_xml::Kind = FlattenedServiceMenu::KIND; } -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "all", ns(EPP_XMLNS))] pub struct All; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "noAccess", ns(EPP_XMLNS))] pub struct NoAccess; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "null", ns(EPP_XMLNS))] pub struct Null; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "personal", ns(EPP_XMLNS))] pub struct Personal; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "personalAndOther", ns(EPP_XMLNS))] pub struct PersonalAndOther; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "other", ns(EPP_XMLNS))] pub struct Other; -/// Type corresponding to possible type values +/// Type corresponding to possible `` type values #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(forward)] pub enum AccessType { - /// Data for the tag + /// Data for the `` tag All(All), - /// Data for the tag + /// Data for the `` tag NoAccess(NoAccess), - /// Data for the tag + /// Data for the `` tag Null(Null), - /// Data for the tag + /// Data for the `` tag Personal(Personal), - /// Data for the tag + /// Data for the `` tag PersonalAndOther(PersonalAndOther), - /// Data for the tag + /// Data for the `` tag Other(Other), } @@ -124,17 +124,17 @@ pub struct Access { inner: AccessType, } -/// Type corresponding to possible type values +/// Type corresponding to possible `` type values #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(forward)] pub enum PurposeType { - /// Data for the tag + /// Data for the `` tag Admin(Admin), - /// Data for the tag + /// Data for the `` tag Contact(Contact), - /// Data for the tag + /// Data for the `` tag Prov(Prov), - /// Data for the tag + /// Data for the `` tag OtherPurpose(OtherPurpose), } @@ -154,26 +154,26 @@ pub struct Prov; #[xml(rename = "otherPurpose", ns(EPP_XMLNS))] pub struct OtherPurpose; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "purpose", ns(EPP_XMLNS))] pub struct Purpose { pub purpose: Vec, } -/// Type corresponding to possible type values +/// Type corresponding to possible `` type values #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(forward)] pub enum RecipientType { - /// Data for the tag + /// Data for the `` tag Other(Other), - /// Data for the tag + /// Data for the `` tag Ours(Ours), - /// Data for the tag + /// Data for the `` tag Public(Public), - /// Data for the tag + /// Data for the `` tag Same(Same), - /// Data for the tag + /// Data for the `` tag Unrelated(Unrelated), } @@ -193,51 +193,51 @@ pub struct Unrelated; #[xml(rename = "same", ns(EPP_XMLNS))] pub struct Same; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "recipient", ns(EPP_XMLNS))] pub struct Recipient { pub recipient: Vec, } -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "business", ns(EPP_XMLNS))] pub struct Business; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "indefinite", ns(EPP_XMLNS))] pub struct Indefinite; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "legal", ns(EPP_XMLNS))] pub struct Legal; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "none", ns(EPP_XMLNS))] pub struct No; -/// Type corresponding to in the EPP greeting XML +/// Type corresponding to `` in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "stated", ns(EPP_XMLNS))] pub struct Stated; -/// Type corresponding to possible type values +/// Type corresponding to possible `` type values #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(forward, rename = "retention", ns(EPP_XMLNS))] pub enum RetentionType { - /// Data for the tag + /// Data for the `` tag Business(Business), - /// Data for the tag + /// Data for the `` tag Indefinite(Indefinite), - /// Data for the tag + /// Data for the `` tag Legal(Legal), - /// Data for the tag + /// Data for the `` tag None(No), - /// Data for the tag + /// Data for the `` tag Stated(Stated), } @@ -247,58 +247,58 @@ pub struct Retention { inner: RetentionType, } -/// Type corresponding to in the EPP greeting XML (pending more compliant implementation) +/// Type corresponding to `` in the EPP greeting XML (pending more compliant implementation) #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "statement", ns(EPP_XMLNS))] pub struct Statement { - /// Data for the tag + /// Data for the `` tag pub purpose: Purpose, - /// Data for the tag + /// Data for the `` tag pub recipient: Recipient, - /// Data for the tag + /// Data for the `` tag pub retention: Retention, } -/// Type corresponding to value in the EPP greeting XML +/// Type corresponding to `` value in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "absolute", ns(EPP_XMLNS))] pub struct Absolute(String); -/// Type corresponding to value in the EPP greeting XML +/// Type corresponding to `` value in the EPP greeting XML #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(rename = "relative", ns(EPP_XMLNS))] pub struct Relative(String); -/// Type corresponding to possible type values +/// Type corresponding to possible `` type values #[derive(Debug, Eq, FromXml, PartialEq)] #[xml(forward)] pub enum ExpiryType { - /// Data for the tag + /// Data for the `