Struct StreamError 

pub struct StreamError {
    pub condition: DefinedCondition,
    pub texts: BTreeMap<Lang, String>,
    pub application_specific: Vec<Element>,
}

Stream error as specified in RFC 6120.

Fields

condition: DefinedCondition

The enumerated error condition which triggered this stream error.

texts: BTreeMap<Lang, String>

Optional error text

application_specific: Vec<Element>

Optional application-defined element which refines the specified Self::condition.

Implementations

impl StreamError

pub fn new<S: Into<String>, L: Into<Lang>>( condition: DefinedCondition, lang: L, text: S, ) -> Self

Create a new StreamError with condition, text, and language

pub fn add_text<L: Into<Lang>, S: Into<String>>(self, lang: L, text: S) -> Self

Add a text element with the specified language

pub fn with_application_specific( self, application_specific: Vec<Element>, ) -> Self

Append application specific element(s)

pub fn get_best_text( &self, preferred_langs: Vec<&str>, ) -> Option<(Lang, &String)>

Get the best matching text from a list of preferred languages.

This follows the same logic as Message::get_best_body:

1. First tries to find a match from the preferred languages list
2. Falls back to empty language (“”) if available
3. Returns the first entry if no matches found

Returns None if no text elements exist.

pub fn get_best_text_cloned( &self, preferred_langs: Vec<&str>, ) -> Option<(Lang, String)>

Cloned variant of StreamError::get_best_text

pub fn has_text(&self) -> bool

Check if the error has any text elements

Trait Implementations

impl AsXml for StreamError

type ItemIter<'xso_proc_as_xml_iter_lifetime> = StreamErrorAsXmlIterator<'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 StreamError

fn clone(&self) -> StreamError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamError

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

Formats the value using the given formatter.

impl Display for StreamError

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

Formats the value using the given formatter.

impl From<&StreamError> for Element

fn from(other: &StreamError) -> Self

Converts to this type from the input type.

impl From<HandledCountTooHigh> for StreamError

fn from(other: HandledCountTooHigh) -> Self

Converts to this type from the input type.

impl From<StreamError> for Element

fn from(other: StreamError) -> Self

Converts to this type from the input type.

impl FromXml for StreamError

type Builder = StreamErrorFromXmlBuilder

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 StreamError

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

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 StreamError