Skip to main content

Files

Struct Files 

Source
pub struct Files<'a> { /* private fields */ }
Expand description

Files resource. Borrows the pooled client; never opens local paths or remote URLs.

Implementations§

Source§

impl Files<'_>

Source

pub async fn create( &self, filename: &str, data: &[u8], options: FileUploadOptions, ) -> Result<FileObject, Error>

Upload JSONL bytes with purpose batch. Identical to the existing flat upload method.

Source

pub async fn retrieve(&self, id: &str) -> Result<FileObject, Error>

Read file metadata.

Source

pub async fn list( &self, options: BatchListOptions<'_>, purpose: Option<&str>, ) -> Result<BatchPage<FileObject>, Error>

Read one page; never automatically paginates.

Source

pub async fn delete(&self, id: &str) -> Result<DeletedFile, Error>

Request deletion.

Source

pub async fn content(&self, id: &str) -> Result<Vec<u8>, Error>

Download bytes within the client’s existing timeout and byte cap.

Source

pub async fn content_with_limit( &self, id: &str, max_bytes: usize, ) -> Result<Vec<u8>, Error>

Override the successful download byte cap for this call only. HTTP errors keep the client-wide cap.

Trait Implementations§

Source§

impl<'a> Clone for Files<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Files<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Files<'a>

§

impl<'a> !UnwindSafe for Files<'a>

§

impl<'a> Freeze for Files<'a>

§

impl<'a> Send for Files<'a>

§

impl<'a> Sync for Files<'a>

§

impl<'a> Unpin for Files<'a>

§

impl<'a> UnsafeUnpin for Files<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more