Struct epp_client::epp::object::EppObject

pub struct EppObject<T: ElementName> {
    pub xmlns: String,
    pub xmlns_xsi: String,
    pub xsi_schema_location: String,
    pub data: T,
}

An EPP XML Document that is used either as an EPP XML request or an EPP XML response

Fields

xmlns: String

XML namespace for the <epp> tag

xmlns_xsi: String

Schema namespace for the <epp> tag

xsi_schema_location: String

Schema location attribute for <epp>

data: T

the request or response object that is set or received in the EPP XML document

Implementations

impl<T: ElementName> EppObject<T>

pub fn build(data: T) -> EppObject<T>

Create the enclosing EPP XML tag <epp> for data that represents an EPP XML request or response

impl EppObject<CommandWithExtension<ContactCheck, EmptyTag>>

pub fn new(contact_ids: Vec<&str>, client_tr_id: &str) -> EppContactCheck

Creates an EppObject corresponding to the <epp> tag with data for a contact check request

impl EppObject<CommandWithExtension<ContactCreate, EmptyTag>>

pub fn new(
    id: &str,
    email: &str,
    postal_info: PostalInfo,
    voice: Phone,
    auth_password: &str,
    client_tr_id: &str
) -> EppContactCreate

Creates a new EppObject for contact create corresponding to the <epp> tag in EPP XML

pub fn set_fax(&mut self, fax: Phone)

Sets the <fax> data for the request

impl EppObject<CommandWithExtension<ContactDelete, EmptyTag>>

pub fn new(id: &str, client_tr_id: &str) -> EppContactDelete

Creates a new EppObject for contact delete corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<ContactInfo, EmptyTag>>

pub fn new(id: &str, auth_password: &str, client_tr_id: &str) -> EppContactInfo

Creates a new EppObject for contact info corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<ContactUpdate, EmptyTag>>

pub fn new(id: &str, client_tr_id: &str) -> EppContactUpdate

Creates a new EppObject for contact update corresponding to the <epp> tag in EPP XML

pub fn set_info(
    &mut self,
    email: &str,
    postal_info: PostalInfo,
    voice: Phone,
    auth_password: &str
)

Sets the data for the <chg> tag for the contact update request

pub fn set_fax(&mut self, fax: Phone)

Sets the data for the <fax> tag under <chg> for the contact update request

pub fn add(&mut self, statuses: Vec<ContactStatus>)

Sets the data for the <add> tag for the contact update request

pub fn remove(&mut self, statuses: Vec<ContactStatus>)

Sets the data for the <rem> tag for the contact update request

pub fn load_from_epp_contact_info(
    &mut self,
    contact_info: EppContactInfoResponse
) -> Result<(), Error>

Loads data into the <chg> tag from an existing EppContactInfoResponse object

impl EppObject<CommandWithExtension<DomainCheck, EmptyTag>>

pub fn new(domains: Vec<&str>, client_tr_id: &str) -> EppDomainCheck

Creates a new EppObject for domain check corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainCreate<HostObjList>, EmptyTag>>

pub fn new_with_ns(
    name: &str,
    period: u16,
    ns: Vec<&str>,
    registrant_id: &str,
    auth_password: &str,
    contacts: Vec<DomainContact>,
    client_tr_id: &str
) -> EppDomainCreate

Creates a new EppObject for domain create corresponding to the <epp> tag in EPP XML with the <ns> tag containing <hostObj> tags

pub fn new(
    name: &str,
    period: u16,
    registrant_id: &str,
    auth_password: &str,
    contacts: Vec<DomainContact>,
    client_tr_id: &str
) -> EppDomainCreate

Creates a new EppObject for domain create corresponding to the <epp> tag in EPP XML without any nameservers

pub fn new_without_contacts(
    name: &str,
    period: u16,
    auth_password: &str,
    client_tr_id: &str
) -> EppDomainCreate

Creates a new EppObject for domain create corresponding to the <epp> tag in EPP XML without any contacts

pub fn new_with_host_attr(
    name: &str,
    period: u16,
    ns: Vec<HostAttr>,
    registrant_id: &str,
    auth_password: &str,
    contacts: Vec<DomainContact>,
    client_tr_id: &str
) -> EppDomainCreateWithHostAttr

Creates a new EppObject for domain create corresponding to the <epp> tag in EPP XML with the <ns> tag containing <hostAttr> tags

impl EppObject<CommandWithExtension<DomainDelete, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppDomainDelete

Creates a new EppObject for domain delete corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainInfo, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppDomainInfo

Creates a new EppObject for domain info corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainRenew, EmptyTag>>

pub fn new(
    name: &str,
    current_expiry_date: NaiveDate,
    years: u16,
    client_tr_id: &str
) -> EppDomainRenew

Creates a new EppObject for domain renew corresponding to the <epp> tag in EPP XML

pub fn set_period(&mut self, period: Period)

impl EppObject<CommandWithExtension<DomainUpdate<HostObjList>, RgpRestoreReport>>

pub fn new(
    name: &str,
    pre_data: &str,
    post_data: &str,
    deleted_at: DateTime<Utc>,
    restored_at: DateTime<Utc>,
    restore_reason: &str,
    statements: Vec<&str>,
    other: &str,
    client_tr_id: &str
) -> EppDomainRgpRestoreReport

Creates a new EppObject for domain rgp restore report corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainUpdate<HostObjList>, RgpRestoreRequest>>

pub fn new(name: &str, client_tr_id: &str) -> EppDomainRgpRestoreRequest

Creates a new EppObject for domain rgp restore request corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainTransfer, EmptyTag>>

pub fn request(
    name: &str,
    years: u16,
    auth_password: &str,
    client_tr_id: &str
) -> EppDomainTransferRequest

Creates a new EppObject for domain transfer request corresponding to the <epp> tag in EPP XML

pub fn set_period(&mut self, period: Period)

Sets the period for renewal in case of a successful transfer

impl EppObject<CommandWithExtension<DomainTransfer, EmptyTag>>

pub fn approve(name: &str, client_tr_id: &str) -> EppDomainTransferApprove

Creates a new EppObject for domain transfer approval corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainTransfer, EmptyTag>>

pub fn cancel(name: &str, client_tr_id: &str) -> EppDomainTransferCancel

Creates a new EppObject for domain transfer request cancellation corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainTransfer, EmptyTag>>

pub fn reject(name: &str, client_tr_id: &str) -> EppDomainTransferReject

Creates a new EppObject for domain transfer rejection corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainTransfer, EmptyTag>>

pub fn query(
    name: &str,
    auth_password: &str,
    client_tr_id: &str
) -> EppDomainTransferQuery

Creates a new EppObject for domain transfer request query corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<DomainUpdate<HostObjList>, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppDomainUpdate

Creates a new EppObject for domain update corresponding to the <epp> tag in EPP XML with the <ns> tag containing <hostObj> tags

pub fn info(&mut self, info: DomainChangeInfo)

Sets the data for the <chg> tag

pub fn add(&mut self, add: DomainAddRemove<HostObjList>)

Sets the data for the <add> tag

pub fn remove(&mut self, remove: DomainAddRemove<HostObjList>)

Sets the data for the <rem> tag

impl EppObject<CommandWithExtension<DomainUpdate<HostAttrList>, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppDomainUpdateWithHostAttr

Creates a new EppObject for domain update corresponding to the <epp> tag in EPP XML with the <ns> tag containing <hostAttr> tags

pub fn info(&mut self, info: DomainChangeInfo)

Sets the data for the <chg> tag

pub fn add(&mut self, add: DomainAddRemove<HostAttrList>)

Sets the data for the <add> tag

pub fn remove(&mut self, remove: DomainAddRemove<HostAttrList>)

Sets the data for the <rem> tag

impl EppObject<CommandWithExtension<HostCheck, EmptyTag>>

pub fn new(hosts: Vec<&str>, client_tr_id: &str) -> EppHostCheck

Creates a new EppObject for host check corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<HostCreate, EmptyTag>>

pub fn new(
    host: &str,
    addresses: Vec<HostAddr>,
    client_tr_id: &str
) -> EppHostCreate

Creates a new EppObject for host create corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<HostDelete, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppHostDelete

Creates a new EppObject for host delete corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<HostInfo, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppHostInfo

Creates a new EppObject for host info corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<HostUpdate, EmptyTag>>

pub fn new(name: &str, client_tr_id: &str) -> EppHostUpdate

Creates a new EppObject for host update corresponding to the <epp> tag in EPP XML

pub fn info(&mut self, info: HostChangeInfo)

Sets the data for the <chg> element of the host update

pub fn add(&mut self, add: HostAddRemove)

Sets the data for the <add> element of the host update

pub fn remove(&mut self, remove: HostAddRemove)

Sets the data for the <rem> element of the host update

impl EppObject<CommandWithExtension<MessageAck, EmptyTag>>

pub fn new(message_id: u32, client_tr_id: &str) -> EppMessageAck

Creates a new EppObject for <poll> ack corresponding to the <epp> tag in EPP XML

impl EppObject<CommandWithExtension<MessagePoll, EmptyTag>>

pub fn new(client_tr_id: &str) -> EppMessagePoll

Creates a new EppObject for <poll> req corresponding to the <epp> tag in EPP XML

impl EppObject<Hello>

pub fn new() -> EppHello

Creates a new Epp Hello request

impl EppObject<CommandWithExtension<Login, EmptyTag>>

pub fn new(
    username: &str,
    password: &str,
    ext_uris: &Option<Vec<String>>,
    client_tr_id: &str
) -> EppLogin

Creates a new EPP Login request

pub fn options(&mut self, options: Options)

Sets the tag data

pub fn services(&mut self, services: Services)

Sets the tag data

impl EppObject<CommandWithExtension<Logout, EmptyTag>>

pub fn new(client_tr_id: &str) -> EppLogout

Creates a new EPP Logout request

Trait Implementations

impl<T: Debug + ElementName> Debug for EppObject<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: ElementName> Deserialize<'de> for EppObject<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Serialize + DeserializeOwned + ElementName + Debug> EppXml for EppObject<T>

fn serialize(&self) -> Result<String, Box<dyn Error>>

Serializes the EppObject instance to an EPP XML document

fn deserialize(epp_xml: &str) -> Result<Self::Output, Error>

Deserializes an EPP XML document to an EppObject instance

type Output = EppObject<T>

impl<T: PartialEq + ElementName> PartialEq<EppObject<T>> for EppObject<T>

fn eq(&self, other: &EppObject<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EppObject<T>) -> bool

This method tests for !=.

impl<T: ElementName + Serialize> Serialize for EppObject<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T: ElementName> StructuralPartialEq for EppObject<T>