Struct DataAnnotation 

#[non_exhaustive]
pub struct DataAnnotation<'source> {
    pub text: Option<Cow<'source, str>>,
    pub markup: Option<Cow<'source, str>>,
    pub interpret_as: Option<Cow<'source, str>>,
}

A portion of text to be checked.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: Option<Cow<'source, str>>

Text that should be treated as normal text.

This or markup is required.

markup: Option<Cow<'source, str>>

Text that should be treated as markup.

This or text is required.

interpret_as: Option<Cow<'source, str>>

If set, the markup will be interpreted as this.

Implementations

impl<'source> DataAnnotation<'source>

pub fn new_text<T: Into<Cow<'source, str>>>(text: T) -> Self

Instantiate a new DataAnnotation with text only.

pub fn new_markup<M: Into<Cow<'source, str>>>(markup: M) -> Self

Instantiate a new DataAnnotation with markup only.

pub fn new_interpreted_markup<M: Into<Cow<'source, str>>, I: Into<Cow<'source, str>>>( markup: M, interpret_as: I, ) -> Self

Instantiate a new DataAnnotation with markup and its interpretation.

pub fn try_get_text(&self) -> Result<Cow<'source, str>>

Return the text or markup within the data annotation.

Errors

If this data annotation does not contain text or markup.

Trait Implementations

impl<'source> Clone for DataAnnotation<'source>

fn clone(&self) -> DataAnnotation<'source>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'source> Debug for DataAnnotation<'source>

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

Formats the value using the given formatter.

impl<'de, 'source> Deserialize<'de> for DataAnnotation<'source>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CliDataAnnotation> for DataAnnotation<'_>

Available on crate feature cli only.

fn from(val: CliDataAnnotation) -> Self

Converts to this type from the input type.

impl<'source> Hash for DataAnnotation<'source>

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<'source> IntoStatic for DataAnnotation<'source>

type Static = DataAnnotation<'static>

fn into_static(self) -> DataAnnotation<'static>

impl<'source> PartialEq for DataAnnotation<'source>

fn eq(&self, other: &DataAnnotation<'source>) -> 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<'source> Serialize for DataAnnotation<'source>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'source> Eq for DataAnnotation<'source>

impl<'source> StructuralPartialEq for DataAnnotation<'source>