Struct DataForm

pub struct DataForm {
    pub type_: DataFormType,
    pub title: Option<String>,
    pub instructions: Option<String>,
    pub fields: Vec<Field>,
}

This is a form to be sent to another entity for filling.

Fields

type_: DataFormType

The type of this form, telling the other party which action to execute.

title: Option<String>

The title of this form.

instructions: Option<String>

The instructions given with this form.

fields: Vec<Field>

A list of fields comprising this form.

Implementations

impl DataForm

pub fn new(type_: DataFormType, form_type: &str, fields: Vec<Field>) -> DataForm

Create a new DataForm.

pub fn form_type(&self) -> Option<&str>

Return the value of the FORM_TYPE field, if any.

An easy accessor for the FORM_TYPE of this form, see XEP-0068 for more information.

pub fn set_form_type(&mut self, ty: String) -> &mut Field

Create or modify the FORM_TYPE field.

If the form has no FORM_TYPE field, this function creates a new field and inserts it at the beginning of the field list. Otherwise, it returns a mutable reference to the existing field.

Panics

If the type of the form is DataFormType::Cancel, this function panics. Such forms should not have any fields and thus no form type.

Trait Implementations

impl AsXml for DataForm

type ItemIter<'xso_proc_as_xml_iter_lifetime> = DataFormAsXmlIterator<'xso_proc_as_xml_iter_lifetime>

The iterator type.

fn as_xml_iter(&self) -> Result<Self::ItemIter<'_>, Error>

Return an iterator which emits the contents of the struct or enum as serialisable Item items.

impl Clone for DataForm

fn clone(&self) -> DataForm

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataForm

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

Formats the value using the given formatter.

impl From<&DataForm> for Element

fn from(other: &DataForm) -> Self

Converts to this type from the input type.

impl From<DataForm> for Element

fn from(other: DataForm) -> Self

Converts to this type from the input type.

impl From<ServerInfo> for DataForm

fn from(server_info: ServerInfo) -> DataForm

Converts to this type from the input type.

impl FromXml for DataForm

type Builder = DataFormFromXmlBuilder

A builder type used to construct the element.

fn from_events( name: QName, attrs: AttrMap, ) -> Result<Self::Builder, FromEventsError>

Attempt to initiate the streamed construction of this struct from XML.

impl PartialEq for DataForm

fn eq(&self, other: &DataForm) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<DataForm> for ServerInfo

type Error = Error

The type returned in the event of a conversion error.

fn try_from(form: DataForm) -> Result<ServerInfo, Error>

Performs the conversion.

impl TryFrom<Element> for DataForm

type Error = FromElementError

The type returned in the event of a conversion error.

fn try_from(other: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for DataForm