Event

Struct Event 

Source
#[non_exhaustive]
pub struct Event { pub data: EventData, pub start_mark: Mark, pub end_mark: Mark, }
Expand description

The event structure.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§data: EventData

The event data.

§start_mark: Mark

The beginning of the event.

§end_mark: Mark

The end of the event.

Implementations§

Source§

impl Event

Source

pub fn stream_start(encoding: Encoding) -> Self

Create the STREAM-START event.

Source

pub fn stream_end() -> Self

Create the STREAM-END event.

Source

pub fn document_start( version_directive: Option<VersionDirective>, tag_directives_in: &[TagDirective], implicit: bool, ) -> Self

Create the DOCUMENT-START event.

The implicit argument is considered as a stylistic parameter and may be ignored by the emitter.

Source

pub fn document_end(implicit: bool) -> Self

Create the DOCUMENT-END event.

The implicit argument is considered as a stylistic parameter and may be ignored by the emitter.

Source

pub fn alias(anchor: &str) -> Self

Create an ALIAS event.

Source

pub fn scalar( anchor: Option<&str>, tag: Option<&str>, value: &str, plain_implicit: bool, quoted_implicit: bool, style: ScalarStyle, ) -> Self

Create a SCALAR event.

The style argument may be ignored by the emitter.

Either the tag attribute or one of the plain_implicit and quoted_implicit flags must be set.

Source

pub fn sequence_start( anchor: Option<&str>, tag: Option<&str>, implicit: bool, style: SequenceStyle, ) -> Self

Create a SEQUENCE-START event.

The style argument may be ignored by the emitter.

Either the tag attribute or the implicit flag must be set.

Source

pub fn sequence_end() -> Self

Create a SEQUENCE-END event.

Source

pub fn mapping_start( anchor: Option<&str>, tag: Option<&str>, implicit: bool, style: MappingStyle, ) -> Self

Create a MAPPING-START event.

The style argument may be ignored by the emitter.

Either the tag attribute or the implicit flag must be set.

Source

pub fn mapping_end() -> Self

Create a MAPPING-END event.

Trait Implementations§

Source§

impl Debug for Event

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Event

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for Event

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnwindSafe for Event

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.