Struct hf_hub::api::sync::Api

source ·
pub struct Api { /* private fields */ }
Expand description

The actual Api used to interacto with the hub. You can inspect repos with [Api::info] or download files with [Api::download]

Implementations§

source§

impl Api

source

pub fn new() -> Result<Self, ApiError>

Creates a default Api, for Api options See ApiBuilder

source

pub fn client(&self) -> &HeaderAgent

Get the underlying api client Allows for lower level access

source

pub fn repo(&self, repo: Repo) -> ApiRepo

Creates a new handle ApiRepo which contains operations on a particular Repo

source

pub fn model(&self, model_id: String) -> ApiRepo

Simple wrapper over

let api = Api::new().unwrap();
let api = api.repo(Repo::new(model_id, RepoType::Model));
source

pub fn dataset(&self, model_id: String) -> ApiRepo

Simple wrapper over

let api = Api::new().unwrap();
let api = api.repo(Repo::new(model_id, RepoType::Dataset));
source

pub fn space(&self, model_id: String) -> ApiRepo

Simple wrapper over

let api = Api::new().unwrap();
let api = api.repo(Repo::new(model_id, RepoType::Space));

Trait Implementations§

source§

impl Clone for Api

source§

fn clone(&self) -> Api

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Api

§

impl Send for Api

§

impl Sync for Api

§

impl Unpin for Api

§

impl !UnwindSafe for Api

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V