Struct GetMarkdownArgs 

#[non_exhaustive]
pub struct GetMarkdownArgs {
    pub file_id_or_url: Option<FileIdOrUrl>,
    pub enable_ocr: bool,
    pub embed_images: bool,
}

Available on crate features dbx_riviera and sync_routes only.

Arguments for the asynchronous get_markdown_async route. Exactly one of file_id, path, or url must be supplied via file_id_or_url to identify the document to convert to markdown.

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.

file_id_or_url: Option<FileIdOrUrl>

Identifier of the document to convert. Callers must set exactly one of the FileIdOrUrl variants. The referenced file must be a document in a supported format (see the route description for the list); requests against unsupported formats return unsupported_format_error.

enable_ocr: bool

Enable OCR for PDF documents. Processing is slower when enabled.

embed_images: bool

When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size.

Implementations

impl GetMarkdownArgs

pub fn with_file_id_or_url(self, value: FileIdOrUrl) -> Self

pub fn with_enable_ocr(self, value: bool) -> Self

pub fn with_embed_images(self, value: bool) -> Self

Trait Implementations

impl Clone for GetMarkdownArgs

fn clone(&self) -> GetMarkdownArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetMarkdownArgs

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

Formats the value using the given formatter.

impl Default for GetMarkdownArgs

fn default() -> GetMarkdownArgs

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetMarkdownArgs

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for GetMarkdownArgs

impl PartialEq for GetMarkdownArgs

fn eq(&self, other: &GetMarkdownArgs) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for GetMarkdownArgs

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetMarkdownArgs