Enum DocumentSource 

#[non_exhaustive]
pub enum DocumentSource {
    Base64 {
        media_type: String,
        data: String,
    },
    Url {
        url: String,
    },
    File {
        file_id: String,
    },
    Text {
        media_type: String,
        data: String,
    },
}

Source of bytes for an KnownBlock::Document.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Base64

Inline base64-encoded bytes.

Fields

media_type: String

MIME type (e.g. application/pdf).

data: String

Base64-encoded document bytes.

Url

Public URL the server should fetch.

Fields

url: String

Document URL.

File

Reference to an uploaded file.

Fields

file_id: String

File ID returned by the Files API.

Text

Inline plain-text document. The API requires media_type for this variant (typically "text/plain"); use ContentBlock::document_text for the common-case constructor.

Fields

media_type: String

MIME type, e.g. "text/plain". Required by the API.

data: String

Document text.

Trait Implementations

impl Clone for DocumentSource

fn clone(&self) -> DocumentSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentSource

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocumentSource

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocumentSource

impl StructuralPartialEq for DocumentSource