Struct DocumentMetadata 

#[non_exhaustive]
pub struct DocumentMetadata {
    pub document: String,
    pub uri: String,
    pub title: String,
    pub page_identifier: String,
    pub struct_data: Option<Struct>,
    /* private fields */
}

Available on crate features conversational-search-service or session-service only.

Document metadata.

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.

document: String

Document resource name.

uri: String

URI for the document.

title: String

Title.

page_identifier: String

Page identifier.

struct_data: Option<Struct>

The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.

Implementations

impl DocumentMetadata

pub fn new() -> Self

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

Sets the value of document.

Example

let x = DocumentMetadata::new().set_document("example");

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

Sets the value of uri.

Example

let x = DocumentMetadata::new().set_uri("example");

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

Sets the value of title.

Example

let x = DocumentMetadata::new().set_title("example");

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

Sets the value of page_identifier.

Example

let x = DocumentMetadata::new().set_page_identifier("example");

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

where T: Into<Struct>,

Sets the value of struct_data.

Example

use wkt::Struct;
let x = DocumentMetadata::new().set_struct_data(Struct::default()/* use setters */);

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

where T: Into<Struct>,

Sets or clears the value of struct_data.

Example

use wkt::Struct;
let x = DocumentMetadata::new().set_or_clear_struct_data(Some(Struct::default()/* use setters */));
let x = DocumentMetadata::new().set_or_clear_struct_data(None::<Struct>);

Trait Implementations

impl Clone for DocumentMetadata

fn clone(&self) -> DocumentMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMetadata

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

Formats the value using the given formatter.

impl Default for DocumentMetadata

fn default() -> DocumentMetadata

Returns the “default value” for a type.

impl Message for DocumentMetadata

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DocumentMetadata

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