Struct folia::select::SelectElementsItem

pub struct SelectElementsItem<'a> {
    pub element: Element<'a>,
}

The Item returned by SelectElementsIterator, this dereferences directly to &ElementData

Fields

element: Element<'a>

Methods from Deref<Target = Element<'a>>

pub fn get_annotation(
    &self,
    annotationtype: AnnotationType,
    set: Cmp<String>,
    recursion: Recursion
) -> Option<Element<'_>>

High-level function to get a particular annotation by annotation type and set. This function returns only one annotation (the first one if there are multiple) and returns None if it does not exists.

pub fn get_annotations(
    &self,
    annotationtype: AnnotationType,
    set: Cmp<String>,
    recursion: Recursion
) -> SelectElementsIterator<'_>

High-level function to get a particular annotation by annotation type and set, returns an iterator.

pub fn get_elements(
    &self,
    elementtype: ElementType,
    set: Cmp<String>,
    recursion: Recursion
) -> SelectElementsIterator<'_>

High-level function to get a particular annotation by annotation type and set, returns an iterator.

pub fn get_element(
    &self,
    elementtype: ElementType,
    set: Cmp<String>,
    recursion: Recursion
) -> Option<Element<'_>>

High-level function to get a particular annotation by element type and set. This function returns only one annotation (the first one if there are multiple) and returns None if it does not exists.

pub fn get_features(&self, subset: Cmp<String>) -> SelectElementsIterator<'_>

High-level function to get a particular feature by annotation type and set, returns an iterator.

pub fn get_feature(&self, subset: Cmp<String>) -> Option<Element<'_>>

High-level function to get a particular feature by annotation type and set, returns an single element (the first feature).

pub fn get_ancestor(
    &self,
    elementtype: ElementType,
    set: Cmp<String>
) -> Option<Element<'_>>

High level-function to get a particular ancestor by annoation type and set. This function returns only one element

pub fn get_ancestor_by_group(
    &self,
    elementgroup: ElementGroup,
    set: Cmp<String>
) -> Option<Element<'_>>

High level-function to get a particular ancestor by annoation type and set. This function returns only one element

pub fn get_ancestors(
    &self,
    elementtype: ElementType,
    set: Cmp<String>
) -> AncestorIterator<'_>

Returns an iterator over the ancestors of this element, starting with the parent and moving up the tree.

pub fn get_ancestors_by_group(
    &self,
    elementgroup: ElementGroup,
    set: Cmp<String>
) -> AncestorIterator<'_>

Returns an iterator over the ancestors of this element, starting with the parent and moving up the tree.

pub fn text_by_key(
    &self,
    set: DecKey,
    textclass: ClassKey,
    strict: bool,
    retaintokenisation: bool,
    previousdelimiter: Option<String>
) -> Result<String, FoliaError>

Returns the text content of a given element

pub fn get_textdelimiter(
    &self,
    retaintokenisation: bool
) -> Result<Cow<'_, str>, FoliaError>

Returns the text delimiter for this element

pub fn text(
    &self,
    textparameters: &TextParameters
) -> Result<String, FoliaError>

Returns the text content of a given element This method takes string parameters for set and textclass, which can be set to None to fallback to the default text set and "current class".

Trait Implementations

impl<'a> Deref for SelectElementsItem<'a>

type Target = Element<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.