Struct FilePath 

pub struct FilePath {
    pub file_id: String,
    pub index: i64,
    pub type_: FilePathType,
}

A path to a file.

JSON schema

{
 "title": "File path",
 "description": "A path to a file.\n",
 "type": "object",
 "required": [
   "file_id",
   "index",
   "type"
 ],
 "properties": {
   "file_id": {
     "description": "The ID of the file.\n",
     "type": "string"
   },
   "index": {
     "description": "The index of the file in the list of files.\n",
     "type": "integer"
   },
   "type": {
     "description": "The type of the file path. Always `file_path`.\n",
     "type": "string",
     "enum": [
       "file_path"
     ],
     "x-stainless-const": true
   }
 }
}

Fields

file_id: String

The ID of the file.

index: i64

The index of the file in the list of files.

type_: FilePathType

The type of the file path. Always file_path.

Trait Implementations

impl Clone for FilePath

fn clone(&self) -> FilePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FilePath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FilePath> for Annotation

fn from(value: FilePath) -> Self

Converts to this type from the input type.

impl Serialize for FilePath

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

where __S: Serializer,

Serialize this value into the given Serde serializer.