Struct MarkupParseContext

pub struct MarkupParseContext { /* private fields */ }

A parse context is used to parse a stream of bytes that you expect to contain marked-up text.

See g_markup_parse_context_new(), #GMarkupParser, and so on for more details.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl MarkupParseContext

pub fn as_ptr(&self) -> *mut GMarkupParseContext

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GMarkupParseContext) -> &Self

Borrows the underlying C value.

impl MarkupParseContext

pub fn end_parse(&self) -> Result<(), Error>

Signals to the #GMarkupParseContext that all data has been fed into the parse context with g_markup_parse_context_parse().

This function reports an error if the document isn’t complete, for example if elements are still open.

Returns

true on success, false if an error was set

pub fn element(&self) -> GString

Retrieves the name of the currently open element.

If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see g_markup_parse_context_get_element_stack().

Returns

the name of the currently open element, or None

pub fn element_stack(&self) -> Vec<GString>

Retrieves the element stack from the internal state of the parser.

The returned #GSList is a list of strings where the first item is the currently open tag (as would be returned by g_markup_parse_context_get_element()) and the next item is its immediate parent.

This function is intended to be used in the start_element and end_element handlers where g_markup_parse_context_get_element() would merely return the name of the element that is being processed.

Returns

the element stack, which must not be modified

pub fn position(&self) -> (i32, i32)

Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the “current” line number other than “the best number we could come up with for error messages.”

Returns

line_number

return location for a line number, or None

char_number

return location for a char-on-line number, or None

pub fn parse(&self, text: &str) -> Result<(), Error>

Feed some data to the #GMarkupParseContext.

The data need not be valid UTF-8; an error will be signaled if it’s invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the #GMarkupParseContext; all errors are fatal.

text

chunk of text to parse

text_len

length of @text in bytes

Returns

false if an error occurred, true on success

Trait Implementations

impl Clone for MarkupParseContext

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for MarkupParseContext

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

Formats the value using the given formatter.

impl From<MarkupParseContext> for Value

fn from(s: MarkupParseContext) -> Self

Converts to this type from the input type.

impl HasParamSpec for MarkupParseContext

type ParamSpec = ParamSpecBoxed

type SetValue = MarkupParseContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, MarkupParseContext>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MarkupParseContext

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MarkupParseContext

fn cmp(&self, other: &MarkupParseContext) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MarkupParseContext

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

fn partial_cmp(&self, other: &MarkupParseContext) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MarkupParseContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MarkupParseContext

impl StructuralPartialEq for MarkupParseContext