Struct File 

pub struct File {
    pub file_data: Option<String>,
    pub file_id: Option<String>,
    pub filename: Option<String>,
    pub file_url: Option<String>,
}

A file attachment for multimodal input.

Fields

file_data: Option<String>

Base64-encoded file data.

file_id: Option<String>

The ID of a previously uploaded file.

filename: Option<String>

The filename for display purposes.

file_url: Option<String>

A URL to fetch the file from.

Implementations

impl File

pub fn prepare(&mut self)

Prepares the file by normalizing empty strings to None.

pub fn is_empty(&self) -> bool

Returns true if all file fields are None.

pub fn file_content(&self) -> Option<FileContent<'_>>

Returns extractable file content if inline file data is present.

Files referenced only by URL or ID return None (kept inline).

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for File

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for File

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromSpecial for File

fn from_special( _special: &Special, _params: &Params<'_, '_>, ) -> Result<Self, ExpressionError>

impl FromStarlarkValue for File

fn from_starlark_value( value: &StarlarkValue<'_>, ) -> Result<Self, ExpressionError>

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for File

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for File

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToStarlarkValue for File

fn to_starlark_value<'v>(&self, heap: &'v StarlarkHeap) -> StarlarkValue<'v>

impl Eq for File

impl StructuralPartialEq for File