Enum FileData 

#[non_exhaustive]
pub enum FileData {
    Bytes {
        data: Bytes,
    },
    Url {
        url: Url,
    },
    Reference {
        reference: BTreeMap<String, String>,
    },
    Text {
        text: String,
    },
}

The payload of a file: inline bytes, a URL, a provider reference or an inline text document.

Wire format is tagged by type: {"type": "data", "data": "<base64>"}, {"type": "url", "url": "..."}, {"type": "reference", "reference": {..}} or {"type": "text", "text": "..."}. Generated files (results, stream parts) only use the data and url forms.

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.

Bytes

Inline bytes, serialized as standard base64 with padding.

Fields

data: Bytes

The bytes.

Url

A URL the provider fetches itself.

Fields

url: Url

The URL.

Reference

A file previously uploaded to one or more providers.

Fields

reference: BTreeMap<String, String>

Provider key → provider-specific file id.

Text

An inline text document.

Fields

text: String

The text.

Implementations

impl FileData

pub fn bytes(data: impl Into<Bytes>) -> FileData

Inline bytes.

pub fn from_base64(text: &str) -> Result<FileData, DecodeError>

Inline bytes from a base64 string (standard alphabet, padding optional).

Errors

Returns the decoding error when text is not valid base64.

pub fn url(url: Url) -> FileData

A URL.

pub fn reference(provider: impl Into<String>, id: impl Into<String>) -> FileData

A reference to a file uploaded to a single provider.

pub fn text(text: impl Into<String>) -> FileData

An inline text document.

pub fn as_bytes(&self) -> Option<&Bytes>

Returns the bytes when inline.

pub fn as_url(&self) -> Option<&Url>

Returns the URL when this is a URL payload.

pub fn as_reference(&self) -> Option<&BTreeMap<String, String>>

Returns the provider reference when this is a reference payload.

pub fn as_text(&self) -> Option<&str>

Returns the text when this is an inline text document.

pub fn to_base64(&self) -> Option<String>

Returns the inline bytes encoded as standard base64.

Trait Implementations

impl Clone for FileData

fn clone(&self) -> FileData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileData

impl From<BTreeMap<String, String>> for FileData

fn from(reference: BTreeMap<String, String>) -> FileData

Converts to this type from the input type.

impl From<Bytes> for FileData

fn from(data: Bytes) -> FileData

Converts to this type from the input type.

impl From<FileData> for FileSource

fn from(data: FileData) -> Self

Converts to this type from the input type.

impl From<Url> for FileData

fn from(url: Url) -> FileData

Converts to this type from the input type.

impl From<Vec<u8>> for FileData

fn from(bytes: Vec<u8>) -> FileData

Converts to this type from the input type.

impl PartialEq for FileData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FileData

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 StructuralPartialEq for FileData

impl TryFrom<FileSource> for FileData

fn try_from(source: FileSource) -> Result<Self, Self::Error>

Converts without I/O: base64 is decoded, URLs (including data:) are passed through, and paths are rejected with FileSourceError::UnreadPath.

type Error = FileSourceError

The type returned in the event of a conversion error.