Struct FileDownloadRequest

pub struct FileDownloadRequest { /* private fields */ }

Request to download file. More details at https://platform.openai.com/docs/api-reference/files/retrieve-content

Usage example

 use openai_req::DownloadRequest;
 use openai_req::files::FileDownloadRequest;

 let req = FileDownloadRequest::new("{file_id}".to_string());
 req.download_to_file(&client, "C:/Downloads/fine-name.ext").await?;

Implementations

impl FileDownloadRequest

pub fn new(file_id: String) -> FileDownloadRequest

Trait Implementations

impl Clone for FileDownloadRequest

fn clone(&self) -> FileDownloadRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDownloadRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileDownloadRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DownloadRequest for FileDownloadRequest

const ENDPOINT: &'static str = "/files/"

const SUFFIX: &'static str = "/content"

fn download<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 OpenAiClient, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<Bytes, Error>>>>>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn download_to_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, client: &'life1 OpenAiClient, target_path: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

impl From<FileInfo> for FileDownloadRequest

fn from(value: FileInfo) -> Self

Converts to this type from the input type.

impl Serialize for FileDownloadRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl WithRefId<str> for FileDownloadRequest

fn id(&self) -> &str