Struct Highlight 

pub struct Highlight {
    pub field: String,
    pub name: String,
    pub fragment_number: usize,
    pub fragment_size: usize,
    pub highlight_markup: bool,
    pub pre_tags: String,
    pub post_tags: String,
}

Specifies the number and size of fragments (snippets, summaries) to generate from each specified field to provide a “keyword in context” (KWIC) functionality. With highlight_markup the matching query terms within the fragments can be highlighted with HTML markup.

Fields

field: String

Specifies the field from which the fragments (snippets, summaries) are created.

name: String

Allows to specifiy multiple highlight result fields from the same source field, leaving the original field intact, Default: if name is empty then field is used instead, i.e the original field is overwritten with the highlight.

fragment_number: usize

If 0/default then return the full original text without fragmenting.

fragment_size: usize

Specifies the length of a highlight fragment. The default 0 returns the full original text without truncating, but still with highlighting if highlight_markup is enabled.

highlight_markup: bool

if true, the matching query terms within the fragments are highlighted with HTML markup <b>term</b>.

pre_tags: String

Specifies the markup tags to insert before each highlighted term (e.g. "<b>" or "<em>"). This can be any string, but is most often an HTML or XML tag. Only used when highlight_markup is set to true.

post_tags: String

Specifies the markup tags to insert after each highlighted term. (e.g. "</b>" or "</em>"). This can be any string, but is most often an HTML or XML tag. Only used when highlight_markup is set to true.

Trait Implementations

impl Clone for Highlight

fn clone(&self) -> Highlight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Highlight

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

Formats the value using the given formatter.

impl Default for Highlight

fn default() -> Highlight

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Highlight

fn deserialize<__D>( __deserializer: __D, ) -> Result<Highlight, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Highlight

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Highlight

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.