Enum stam::SelectorBuilder

pub enum SelectorBuilder<'a> {
    ResourceSelector(BuildItem<'a, TextResource>),
    AnnotationSelector(BuildItem<'a, Annotation>, Option<Offset>),
    TextSelector(BuildItem<'a, TextResource>, Offset),
    DataSetSelector(BuildItem<'a, AnnotationDataSet>),
    DataKeySelector(BuildItem<'a, AnnotationDataSet>, BuildItem<'a, DataKey>),
    AnnotationDataSelector(BuildItem<'a, AnnotationDataSet>, BuildItem<'a, AnnotationData>),
    MultiSelector(Vec<SelectorBuilder<'a>>),
    CompositeSelector(Vec<SelectorBuilder<'a>>),
    DirectionalSelector(Vec<SelectorBuilder<'a>>),
}

A SelectorBuilder is a recipe that, when applied, identifies the target of an annotation and the part of the target that the annotation applies to. They produce a Selector. You turn a SelectorBuilder into a Selector using AnnotationStore::selector.

A SelectorBuilder can refer to anything and is not validated yet, a Selector is and should not fail.

There are multiple types of selectors, all captured in this enum.

Variants

ResourceSelector(BuildItem<'a, TextResource>)

AnnotationSelector(BuildItem<'a, Annotation>, Option<Offset>)

TextSelector(BuildItem<'a, TextResource>, Offset)

DataSetSelector(BuildItem<'a, AnnotationDataSet>)

DataKeySelector(BuildItem<'a, AnnotationDataSet>, BuildItem<'a, DataKey>)

AnnotationDataSelector(BuildItem<'a, AnnotationDataSet>, BuildItem<'a, AnnotationData>)

MultiSelector(Vec<SelectorBuilder<'a>>)

CompositeSelector(Vec<SelectorBuilder<'a>>)

DirectionalSelector(Vec<SelectorBuilder<'a>>)

Implementations

impl<'a> SelectorBuilder<'a>

pub fn kind(&self) -> SelectorKind

Returns a SelectorKind

pub fn is_complex(&self) -> bool

A complex selector targets multiple targets. Note the internal ranged selector is not counted as part of this category.

pub fn resourceselector( resource: impl Into<BuildItem<'a, TextResource>> ) -> Self

Creates a new ResourceSelector

pub fn textselector( resource: impl Into<BuildItem<'a, TextResource>>, offset: impl Into<Offset> ) -> Self

Creates a new TextSelector

pub fn annotationselector( annotation: impl Into<BuildItem<'a, Annotation>>, offset: Option<Offset> ) -> Self

Creates a new AnnotationSelector

pub fn datasetselector( dataset: impl Into<BuildItem<'a, AnnotationDataSet>> ) -> Self

Creates a new DataSetSelector

pub fn datakeyselector( dataset: impl Into<BuildItem<'a, AnnotationDataSet>>, datakey: impl Into<BuildItem<'a, DataKey>> ) -> Self

Creates a new DataKeySelector

pub fn annotationdataselector( dataset: impl Into<BuildItem<'a, AnnotationDataSet>>, annotationdata: impl Into<BuildItem<'a, AnnotationData>> ) -> Self

Creates a new AnnotationDataSelector

pub fn multiselector<I>(iter: I) -> Self

where I: IntoIterator<Item = SelectorBuilder<'a>>,

Creates a new MultiSelector from an iterator

pub fn compositeselector<I>(iter: I) -> Self

where I: IntoIterator<Item = SelectorBuilder<'a>>,

Creates a new CompositeSelector from an iterator

pub fn directionalselector<I>(iter: I) -> Self

where I: IntoIterator<Item = SelectorBuilder<'a>>,

Creates a new DirectionalSelector from an iterator

pub fn offset(&self) -> Option<&Offset>

Returns the offset associated with the selector (if any)

pub fn resource(&self) -> Option<&BuildItem<'a, TextResource>>

Returns the resource associated with the selector (if any)

Trait Implementations

impl<'a> Debug for SelectorBuilder<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for SelectorBuilder<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&SelectorBuilder<'a>> for SelectorKind

fn from(selector: &SelectorBuilder<'a>) -> Self

Converts to this type from the input type.