Struct poppler::StructureElementIter

pub struct StructureElementIter { /* private fields */ }

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl StructureElementIter

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut( ptr: &mut *mut PopplerStructureElementIter, ) -> &mut Self

Borrows the underlying C value mutably.

impl StructureElementIter

pub fn new(poppler_document: &Document) -> StructureElementIter

Returns the root StructureElementIter for document, or None. The returned value must be freed with poppler_structure_element_iter_free().

Documents may have an associated structure tree —mostly, Tagged-PDF compliant documents— which can be used to obtain information about the document structure and its contents. Each node in the tree contains a StructureElement.

Here is a simple example that walks the whole tree:

<informalexample>``<programlisting> static void walk_structure (PopplerStructureElementIter iter) { do { / Get the element and do something with it */ PopplerStructureElementIter *child = poppler_structure_element_iter_get_child (iter); if (child) walk_structure (child); poppler_structure_element_iter_free (child); } while (poppler_structure_element_iter_next (iter)); } … { iter = poppler_structure_element_iter_new (document); walk_structure (iter); poppler_structure_element_iter_free (iter); } </programlisting>``</informalexample>

poppler_document

a Document.

Returns

a new StructureElementIter, or None if document doesn’t have structure tree.

pub fn child(&mut self) -> Option<StructureElementIter>

Returns a new iterator to the children elements of the StructureElement associated with iter. The returned value must be freed with poppler_structure_element_iter_free().

Returns

a new StructureElementIter

pub fn element(&mut self) -> Option<StructureElement>

Returns the StructureElementIter associated with self.

Returns

a new StructureElementIter

pub fn next(&mut self) -> bool

Sets self to point to the next structure element at the current level of the tree, if valid. See new() for more information.

Returns

true, if self was set to the next structure element

Trait Implementations

impl Clone for StructureElementIter

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for StructureElementIter

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

Formats the value using the given formatter.

impl From<StructureElementIter> for Value

fn from(o: StructureElementIter) -> Self

Converts to this type from the input type.

impl HasParamSpec for StructureElementIter

type ParamSpec = ParamSpecBoxed

type SetValue = StructureElementIter

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StructureElementIter

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 StructureElementIter

fn cmp(&self, other: &StructureElementIter) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StructureElementIter

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for StructureElementIter

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for StructureElementIter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StructureElementIter

impl StructuralPartialEq for StructureElementIter