Struct DocumentSchema 

#[non_exhaustive]
pub struct DocumentSchema {
    pub display_name: String,
    pub description: String,
    pub entity_types: Vec<EntityType>,
    pub metadata: Option<Metadata>,
    /* private fields */
}

The schema defines the output of the processed document by a processor.

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.

display_name: String

Display name to show to users.

description: String

Description of the schema.

entity_types: Vec<EntityType>

Entity types of the schema.

metadata: Option<Metadata>

Metadata of the schema.

Implementations

impl DocumentSchema

pub fn new() -> Self

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_entity_types<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EntityType>,

Sets the value of entity_types.

pub fn set_metadata<T>(self, v: T) -> Self

where T: Into<Metadata>,

Sets the value of metadata.

pub fn set_or_clear_metadata<T>(self, v: Option<T>) -> Self

where T: Into<Metadata>,

Sets or clears the value of metadata.

Trait Implementations

impl Clone for DocumentSchema

fn clone(&self) -> DocumentSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSchema

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

Formats the value using the given formatter.

impl Default for DocumentSchema

fn default() -> DocumentSchema

Returns the “default value” for a type.

impl Message for DocumentSchema

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DocumentSchema

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