Struct VisitChildrenResult

pub struct VisitChildrenResult(/* private fields */);

The return value of the ItemTree::visit_children_item function

Represents something like enum { Continue, Aborted{aborted_at_item: isize} }. But this is just wrapping a int because it is easier to use ffi with isize than complex enum.

-1 means the visitor will continue otherwise this is the index of the item that aborted the visit.

Implementations

impl VisitChildrenResult

pub const CONTINUE: Self

The result used for a visitor that want to continue the visit

pub fn abort(item_index: u32, index_within_repeater: usize) -> Self

Returns a result that means that the visitor must stop, and convey the item that caused the abort

pub fn has_aborted(&self) -> bool

True if the visitor wants to abort the visit

pub fn aborted_index(&self) -> Option<usize>

pub fn aborted_indexes(&self) -> Option<(usize, usize)>

Trait Implementations

impl Clone for VisitChildrenResult

fn clone(&self) -> VisitChildrenResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VisitChildrenResult

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

Formats the value using the given formatter.

impl PartialEq for VisitChildrenResult

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

impl Eq for VisitChildrenResult

impl StructuralPartialEq for VisitChildrenResult