Struct Upload

pub struct Upload {
    pub id: String,
    pub created_at: i64,
    pub filename: String,
    pub bytes: i64,
    pub purpose: String,
    pub status: UploadStatus,
    pub expires_at: i64,
    pub object: Option<UploadObject>,
    pub file: Option<OpenAiFile>,
}

The Upload object can accept byte chunks in the form of Parts.

Fields

id: String

The Upload unique identifier, which can be referenced in API endpoints.

created_at: i64

The Unix timestamp (in seconds) for when the Upload was created.

filename: String

The name of the file to be uploaded.

bytes: i64

The intended number of bytes to be uploaded.

purpose: String

The intended purpose of the file. Please refer here for acceptable values.

status: UploadStatus

The status of the Upload.

expires_at: i64

The Unix timestamp (in seconds) for when the Upload will expire.

object: Option<UploadObject>

The object type, which is always “upload”.

file: Option<OpenAiFile>

The ready File object after the Upload is completed.

Implementations

impl Upload

pub fn builder() -> UploadBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building Upload. On the builder, call .id(...), .created_at(...), .filename(...), .bytes(...), .purpose(...), .status(...), .expires_at(...), .object(...)(optional), .file(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Upload.

Trait Implementations

impl Clone for Upload

fn clone(&self) -> Upload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Upload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Upload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Upload

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

Tests for self and other values to be equal, and is used by ==.

const 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 Upload

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Upload