Struct Field

pub struct Field {
    pub var: Option<String>,
    pub type_: FieldType,
    pub label: Option<String>,
    pub required: bool,
    pub desc: Option<String>,
    pub options: Vec<Option_>,
    pub values: Vec<String>,
    pub media: Vec<MediaElement>,
    pub validate: Option<Validate>,
}

Represents a field in a data form.

Fields

var: Option<String>

The unique identifier for this field, in the form.

type_: FieldType

The type of this field.

label: Option<String>

The label to be possibly displayed to the user for this field.

required: bool

The form will be rejected if this field isn’t present.

desc: Option<String>

The natural-language description of the field, intended for presentation in a user-agent

options: Vec<Option_>

A list of allowed values.

values: Vec<String>

The values provided for this field.

media: Vec<MediaElement>

A list of media related to this field.

validate: Option<Validate>

Validation rules for this field.

Implementations

impl Field

pub fn new(var: &str, type_: FieldType) -> Field

Create a new Field, of the given var and type.

pub fn with_value(self, value: &str) -> Field

Set only one value in this Field.

pub fn text_single(var: &str, value: &str) -> Field

Create a text-single Field with the given var and unique value.

pub fn is_form_type(&self, ty: &DataFormType) -> bool

Return true if this field is a valid form type specifier as per XEP-0068.

This function requires knowledge of the form’s type attribute as the criteria differ slightly among form types.

Trait Implementations

impl AsXml for Field

type ItemIter<'xso_proc_as_xml_iter_lifetime> = FieldAsXmlIterator<'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.

fn as_xml_dyn_iter<'x>( &'x self, ) -> Result<Box<dyn Iterator<Item = Result<Item<'x>, Error>> + 'x>, Error>

Return the same iterator as as_xml_iter, but boxed to erase the concrete iterator type.

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl From<&Field> for Element

fn from(other: &Field) -> Self

Converts to this type from the input type.

impl From<Field> for Element

fn from(other: Field) -> Self

Converts to this type from the input type.

impl FromXml for Field

type Builder = FieldFromXmlBuilder

A builder type used to construct the element.

fn from_events( name: QName, attrs: AttrMap, ctx: &Context<'_>, ) -> Result<Self::Builder, FromEventsError>

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

fn xml_name_matcher() -> XmlNameMatcher<'static>

Return a predicate which determines if Self may be parsed from a given XML element.

impl PartialEq for Field

fn eq(&self, other: &Field) -> 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<Element> for Field

type Error = FromElementError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Field